Device Streams

Stream Fermentation data from devices.

Post Device Stream Data

POST https://log.brewersfriend.com/stream/:api_key

This endpoint allows you to post device stream data. The request should be a JSON object. The first time you post to this endpoint a device will be created by the name you set. After that you will select this device in the Brew Session -> Fermentation tab. Replace

:api_key

with your API key.

Headers

Name	Type	Description
Content-Type	string	application/json
X-API-KEY	string	If not in the url then it can be added as a header.

Request Body

Name	Type	Description
bpm	number	Bubbles Per Minute for Plaato like devices.
device_source	string	Tilt, iSpindel, Floaty, DS18B20 Sensor, etc.
report_source	string	MyBrewBot, Fermentrack, BrewBench, etc.
heat_state	string	heating, cooling, off
temp_target	number	Target Temperature, same unit as temp_unit.
gravity_target	number	Target Gravity, same unit as gravity_unit.
og	number	Original Gravity, same unit as gravity_unit.
hysteresis	number
psi	number	Fermenter PSI.
ambient	number	Room ambient temperature, same unit as temp_unit.
name	string	Name of your streaming device.
temp	number
temp_unit	string	C (default) or F for Celsius or Fahrenheit
gravity	number
gravity_unit	string	P (default) or G for Plato or Gravity
ph	number
comment	string
beer	string
battery	number
RSSI	number
angle	number

200 Reading successfully posted.

{
    "message": "success",
    "detail": "Saved 5c5b7d4f6ea3a6e58c08a702"
}

400 There is an issue with data posted. Check fields and data types.

{
    "message": "failure",
    "detail": "failed to create record"
}

401 There is an issue with your API key.

{
    "message": "unauthorized",
    "detail": "invalid api key"
}

429 There is a rate limit of one request every 15 minutes per API key per brew session.

{
    "message": "rate-limit",
    "detail": "device rate limit, you are only allowed to post once every 15 minutes."
}

Here is an example of the data to POST.

{
 "name": "BrewBench",
 "temp": 22.2,
 "temp_unit": "C",
 "gravity": 14.1,
 "gravity_unit": "P",
 "ph": 4.5,
 "comment": "",
 "beer": "",
 "battery": 3.588112,
 "RSSI": -57,
 "angle": ""
}