Difference between revisions of "Allwize library"

From AllWize Wiki
Jump to navigation Jump to search
Line 21: Line 21:
 
Authors: AllWize.io, Xose Pérez
 
Authors: AllWize.io, Xose Pérez
 
</pre>
 
</pre>
 +
 +
== Code examples ==
 +
 +
The library provides several examples to learn the different possibilities it offers:
 +
 +
* factoryReset: shows how to factory reset the radio module
 +
* lorawan: example on how to use Wize to encapsulate a LoRaWAN frame and send it to The Things Network
 +
** lorawan_gateway: code to use with an ESP8266 to receive a Wize encapsulated LoRaWAN frame and send it to TTN using Semtech Legacy Protocol
 +
** lorawan_node: code to send a LoRaWAN frame via Wize
 +
* lowpower: example on how to lowpower the radio an microcontroller (AVR, SAMD)
 +
* master: different examples on how to create a master (single channel gateway) with the library
 +
** master_allwize_k1_esp8266: ESP8266 master
 +
** master_allwize_k1_leonardo: Arduino Leonardo master
 +
** master_allwize_k2: AllWize K2 master
 +
* moduleInfo: shows radio module configuration and non-volatile memory dump
 +
* slave
 +
** slave_allwize_k1_esp32
 +
** slave_allwize_k1_esp8266
 +
** slave_allwize_k1_leonardo
 +
** slave_allwize_k1_uno
 +
** slave_allwize_k1_zero
 +
** slave_allwize_k2
 +
** slave_allwize_k2_mbus
 +
* use_cases
 +
** sensor-bme280
 +
** sensor-hcsr04
 +
** sensor-mcp9701
 +
** sensor-mhz16
 +
** sensor-mics4514
 +
** sensor-si7021
 +
** uc-vineryards
 +
** uc-wcpaper
 +
* wize2mqtt
 +
* wize2mqtt_mbus
 +
* wize2serial
 +
* wize2thethingsio
  
 
== Reference links ==
 
== Reference links ==

Revision as of 10:10, 19 August 2019

The AllWize Library is an Arduino compatible library to interface the RadioCrafts RC1701HP-XXX radio module.

The library is available in the Arduino IDE Library Manager:

Arduino IDE Library Manager

And also in the PlatformIO Library Manager:

$ pio lib search allwize
Found 1 libraries:

AllWize
=======
#ID: 5804
Arduino-compatible library to interface RC1701HP-OSP/WIZE radio modules

Keywords: wize, radio, radiocrafts, wmbus4
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 32, Espressif 8266
Authors: AllWize.io, Xose Pérez

Code examples

The library provides several examples to learn the different possibilities it offers:

  • factoryReset: shows how to factory reset the radio module
  • lorawan: example on how to use Wize to encapsulate a LoRaWAN frame and send it to The Things Network
    • lorawan_gateway: code to use with an ESP8266 to receive a Wize encapsulated LoRaWAN frame and send it to TTN using Semtech Legacy Protocol
    • lorawan_node: code to send a LoRaWAN frame via Wize
  • lowpower: example on how to lowpower the radio an microcontroller (AVR, SAMD)
  • master: different examples on how to create a master (single channel gateway) with the library
    • master_allwize_k1_esp8266: ESP8266 master
    • master_allwize_k1_leonardo: Arduino Leonardo master
    • master_allwize_k2: AllWize K2 master
  • moduleInfo: shows radio module configuration and non-volatile memory dump
  • slave
    • slave_allwize_k1_esp32
    • slave_allwize_k1_esp8266
    • slave_allwize_k1_leonardo
    • slave_allwize_k1_uno
    • slave_allwize_k1_zero
    • slave_allwize_k2
    • slave_allwize_k2_mbus
  • use_cases
    • sensor-bme280
    • sensor-hcsr04
    • sensor-mcp9701
    • sensor-mhz16
    • sensor-mics4514
    • sensor-si7021
    • uc-vineryards
    • uc-wcpaper
  • wize2mqtt
  • wize2mqtt_mbus
  • wize2serial
  • wize2thethingsio

Reference links