The Bricks API is fully documented and open to everyone. If you are a software dev, this section will help you to turn your hardware into a "Brick" and interact with our software.
The sensor / actory key (
sakey) has follow the following schema (
$xall fields are prefixed with
$ydatatype of the sensor / actor. currently supported are
$zthe physical meaning, e.g.
wortfor sensors. or
$iindex on the device, starts with 0. This allows enumeration if multiple interfaces are of the same type. The index needs to be incremented for all groups of
$z(the datatype is not relevant).
Return value is a JSON map
Attention: Pay respect to the
next_request_msfield. Especially if you contact the backend repetitively too early your Brick might get banned permanently.
- Device 1:
s_number_temp_0: first sensor sending a temperature number.
s_number_temp_1: second sensor sending a temperature number.
s_number_temp_id_0: ID of the first temperature sensor, i.e.
a_number_epower_0: This a PWM actor.
a_bool_epower_1: note, how index is incremented, despite the change of
Example request by the BierBot Brick would look like
Sample implementations are available in