ESP32

nRF905 Arduino API

nRF905 Arduino API. Compatible with ESP8266 and ESP32 boards, tested on Wemos D1 mini Pro, NodeMCU 1.0 (ESP-12E module) and DOIT ESP32 Dev Module.

Building the hardware

See Buiding the hardware

Compiling / Installing

1. Install the Arduino IDE
2. Open the nRF905API.ino file in Arduino IDE
3. In the File menu select Preferences and add the following to Additional Board Manager URLs:

https://arduino.esp8266.com/stable/package_esp8266com_index.json,https://dl.espressif.com/dl/package_esp32_index.json

4. In the Tools menu select Board and find the board you are using (DO-IT ESP32 / Wemos / NodeMCU etc).
5. In the Sketch menu select Upload
6. When the code has been uploaded the device will reboot and start a WiFi access point named nRF905. Connect to that access point with the password nrf905api.
7. Open a webbrowser and go to http://192.168.4.1/
8. Follow the configuration wizard:
   
   
   
   
   
   
   
   
9. Your device will now connect to your WiFi network.

Support

Due to lack of time it might take a long time for me to give support.

Usage

/api/v1/config.json

Configure the nRF905.

Example:
http://192.168.x.y/api/v1/config.json?frequency=868400000&crc=16&txpower=10&rxpower=normal&rxaddr=a55a5aa5&txaddr=a55a5aa5&rxaddrwidth=4&txaddrwidth=4&rxpayloadwidth=16&txpayloadwidth=16

/api/v1/status.json

This will show a status page with details about the hardware. This API call takes no parameters.

Example:
http://192.168.x.y/api/v1/status.json

/api/v1/receive.json

This will return a list of received data frames by the nRF905. This API call takes no parameters.

Example:
http://192.168.x.y/api/v1/receive.json

/api/v1/send.json

This will transmit data. After the data has been transmitted, the API will wait for data to be received (a reply to the transmitted data). By default it will wait for 2 seconds, but you can change this by adding the timeout parameter.

Example:
http://192.168.x.y/api/v1/send.json?txaddr=aabbccdd&payload=0400035efa0c04a55a5aa50000000000&timeout=10

/api/v1/systemconfig.json

Configure the system board.

Example:
http://192.168.x.y/api/v1/systemconfig.json?reset=true

Fan API calls

/api/v2/fan/link.json

Link the nRF905-API to a fan device. This API call takes no parameters.

Example:
http://192.168.x.y/api/v2/fan/link.json

/api/v2/fan/config.json

Configure the fan parameters.

Example:
http://192.168.x.y/api/v2/fan/config.json?model=zehnder&network=1a2b3c4d&main_unit_id=91&device_id=5d

/api/v2/fan/setspeed.json

Set the fan speed of your fan device.

Example:
http://192.168.x.y/api/v2/fan/setspeed.json?speed=high

/api/v2/fan/setvoltage.json

Set the fan voltage of your fan device.

Example:
http://192.168.x.y/api/v2/fan/setvoltage.json?voltage=2.4

/api/test/fan/querydevice.json

Query a device for it's current settings (this API endpoint is not yet finished and is in test-mode).

Example:
http://192.168.x.y/api/test/fan/querydevice.json?device_id=32

Disclaimer

This project is an independent, unofficial project. It is not affiliated with, endorsed by or supported by Zehnder Group, BUVA, ESPHome, Nabu Casa or any other manufacturer or organisation mentioned. All product names, trademarks and other intellectual property of third parties mentioned in this project remain the property of their respective owners and are used for identification and interoperability only.

The information and software in this project are provided "as is", for personal and educational use, without warranty of any kind, express or implied, including fitness for a particular purpose. The protocol description was obtained by observing radio traffic and may be incomplete or wrong. Using this project to control ventilation equipment is at your own risk: it may, for example, affect the equipment's warranty, or its ventilation of your home.

You must not use this project, or any information in it, in a harmful or illegal way, including in ways that violate radio regulations or the rights of others. The author(s) of this project and the owners of any third-party intellectual property cannot be held liable for any damage or loss resulting from the use or misuse of this project or its information.