Git Product home page Git Product logo

api-docs's Introduction

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

  1. Press the sensor's button for at least 3 seconds, until the LED turns and stays orange.
  2. 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.
  3. 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.
  4. Goto http://172.29.0.1/ and enter the WIFI credentials and any user credentials (just enter anything that looks valid, these are not used, but required for the connection to be setup) and click 'connect'.

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

Write an e-mail to [email protected] and mention the MAC addresses of your sensors. Within a few days we will reply with the symmetric keys and calibration data.

Third-Party Server Implementations

api-docs's People

Contributors

koalatux avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.