Bricks
  • Welcome
  • Getting Started
    • Terminology
    • Adding your first BierBot Brick
    • Setting up your first mashtun
    • Creating / importing recipes
    • Starting your first brew
    • FAQ
  • Hardware / Bricks
    • Overview - available Bricks
      • BierBot Brick
      • TILTâ„¢
      • iSpindel / iSpindle
      • Raspberry Pi
      • Brick 32
      • HYDROM
      • RaptPill
  • Using Bricks
    • Setup your Bricks account
    • Managing your brewery
    • Equipment
      • Calibration
      • PDI control settings
    • Equipment types
      • Mashtun
      • BIAB / MLT / HLT
      • HERMS (advanced)
      • Fermenter
    • Manual mode
    • Automatic mode
      • Gravity history
    • Brewlogs
    • Your settings
  • Developer Section
    • Bricks API
      • Connecting displays
    • Pro API
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. Developer Section
  2. Bricks API

Connecting displays

BierBot Bricks exposes an API to query information about your currently ongoing brews. You will get the brew name, current and target temperatures, and (if the next step is due after a set amount of time and the temperature was reached) the time until the the next action.

Endpoint for getting statistics about currently running brews.

GET https://brewbricks.com/api/iot/v1

Request Body

Name
Type
Description

apikey*

String

your API key as for all other Bricks

type*

String

always has to be display

brand*

String

always has to be oss

version*

String

version of the display software running

chipid*

String

A uniquie identifier for this Brick. Can be the chip ID or also any other unique and always permanent value

d_object_information_0*

String

Specifies the shape of your display. I.e. 4x20 for a typical 4 by 20 display.

{
    // Response
}

A sample response looks like this:

{
    "result": "success",
    "error": 0,
    "error_text": "",
    "warning": 0,
    "warning_text": "",
    "settings": {
        "temperatureUnit": "celsius",
        "displayBrewEveryS": 5,
        "showLocalIP": false
    },
    "brews": [
        {
            "currentTemperatureC": {
                "na": -273,
                "primary": 10,
                "secondary": -273,
                "hlt": -273,
                "mlt": -273
            },
            "id": "T1muylAbPsxkZ389ha1z",
            "name": "Pils (TILT)",
            "targetTemperatureC": 10,
            "nextEvents": [
                {
                    "timeRemainingS": 85587.428,
                    "type": "step"
                }
            ]
        },
        {
            "currentTemperatureC": {
                "na": -273,
                "primary": 11.06,
                "secondary": -273,
                "hlt": -273,
                "mlt": -273
            },
            "id": "DcfimLZm4PFMaTErounA",
            "name": "Pils (iSpindel + Steuerung)",
            "targetTemperatureC": 14,
            "nextEvents": []
        }
    ],
    "next_request_ms": 15000
}
PreviousBricks APINextPro API

Last updated 1 year ago

Was this helpful?