silvermind/api-docs

Koubachi Sensor API Documentation

Server API

The communication between the sensor and the server is encrypted. Read more about the encryption or see a Python code example.

A server must implement three endpoints:

• update - Intended to be used to associate a sensor with a user account, used by the config app to test the connection.
• config_show - Used by the sensor to retrieve its configuration, e.g. which sensors are enabled, how often to measure and how often to transmit stored readings.
• readings_add - Used by the sensor to transmit its stored readings.

Change the Sensor's Server Address

Press the sensor's button for at least 3 seconds, until the LED turns and stays orange. Connect to the sensor's config Wi-Fi and open the configuration page in your browser http://172.29.0.1/ to see if the connection works. Then change the URL in your browser's address bar to http://172.29.0.1/sos_config?host=api.example.com&port=8005 with your desired host and port. The host can be a hostname or an IPv4 address.

To get your current configuration visit http://172.29.0.1/sos_config.

This setting is lost after a factory reset.

Get the Sensor's Symmetric Key

You can retrieve your sensor's encryption key together with all calibration parameters at the Koubachi Labs web site.

Third-Party Server Implementations

• Implementation in Python 3