Method

-        GET /api/v2/status

Returns:

Attribute

Type

Required

Description

MA_STATUS

uint8

Yes

ps.Machine.Status

Example response:

{
  "MA_STATUS" : 0
}

 

Method

-        GET /api/v2/overview

Returns:

Attribute

Type

Required

Description

MA_EXTRACTIONS

uint32

Yes

ps.Machine.Extractions

MA_OPERATING_HOURS

uint32

Yes

ps.Machine.OperatingHours

MA_STATUS

uint8

Yes

ps.Machine.Status

MA_CLOCK

uint32

Yes

ps.MachineMon.Clock

MA_CUR_PWR

float

Yes

ps.MachineMon.SensCurrPwr

MA_MAX_PWR

uint16

Yes

ps.Machine.MaxAmpere

MA_ENERGY_TOTAL_KWH

float

Yes

ps.MachineMon.EnergyTotalkwH

BG_SENS_TEMP_A

float

Yes

ps.BrewgroupMon.SensTempA

BG_LEVEL_PW_CONTROL

uint16

Yes

ps.BrewgroupMon.LevelPwControl

PU_SENS_PRESS

float

Yes

ps.PumpMon.SensPressure

PU_LEVEL_PW_CONTROL

uint16

Yes

ps.PumpMon.LevelPwControl

PU_SET_LEVEL_PW_CONTROL

uint16

Yes

ps.PumpMon.SetLevelPwControl

SB_SENS_PRESS

float

Yes

ps.SteamboilerMon.SensPressure

BB_SENS_TEMP_A

float

Yes

ps.BrewboilerMon.SensTempA

BB_LEVEL_PW_CONTROL

uint16

Yes

ps.BrewboilerMon.LevelPwControl

SB_STATUS

uint8

Yes

ps.SteamboilerMon.Status

MA_LAST_EXTRACTION_ML

String

Yes

last extraction amount

Example response:

{
  "MA_EXTRACTIONS": 52,
  "MA_OPERATING_HOURS": 3560,
  "MA_STATUS": 0,
  "MA_CLOCK": 721974,
  "MA_CUR_PWR": 0,
  "MA_MAX_PWR": 10,
  "MA_ENERGY_TOTAL_KWH": 0.000144649,
  "BG_SENS_TEMP_A": 0,
  "BG_LEVEL_PW_CONTROL": 0,
  "PU_SENS_PRESS": 0,
  "PU_LEVEL_PW_CONTROL": 0,
  "PU_SET_LEVEL_PW_CONTROL": 0,
  "SB_SENS_PRESS": 0,
  "BB_SENS_TEMP_A": 0,
  "BB_LEVEL_PW_CONTROL": 0,
  "SB_STATUS": 1,
  "MA_LAST_EXTRACTION_ML": ""
}

 

Method

-        GET /api/v2/overview_single

Returns:

Attribute

Type

Required

Description

BG_SET_TEMP

float

Yes

ps.Brewgroup.SetTemp

PU_SET_PRESS

float

Yes

ps.Pump.SetPressure

PU_SENS_WATER_TANK_LEVEL

uint8

Yes

ps.PumpMon.SensWaterTankLevel

SB_SET_PRESS

float

Yes

ps.Steamboiler.SetPressure

BB_SET_TEMP

float

Yes

ps.Brewboiler.SetTemp

PSP

uint8

Yes

ps.Port.SetPump

MA_MAC

String

Yes

WiFi.macAddress()

MA_EXTRACTIONS_START

uint32

Yes

starting extractions

POP_UP

uint8

No

pop up

Example response:

{
  "BG_SET_TEMP": 95,
  "PU_SET_PRESS": 9,
  "PU_SENS_WATER_TANK_LEVEL": 1,
  "SB_SET_PRESS": 0,
  "BB_SET_TEMP": 95,
  "PSP": 0,
  "MA_MAC": "10:97:BD:CD:99:00",
  "MA_EXTRACTIONS_START": 0
}

 

Method

-        GET /api/v2/diagram_get

Returns:

Attribute

Type

Required

Description

BG_LEVEL_PW_CONTROL

uint16

Yes

ps.BrewgroupMon.LevelPwControl

BB_LEVEL_PW_CONTROL

uint16

Yes

ps.BrewboilerMon.LevelPwControl

BG_SENS_TEMP_A

float

Yes

ps.BrewgroupMon.SensTempA

BB_SENS_TEMP_A

float

Yes

ps.BrewboilerMon.SensTempA

PU_SENS_FLOW_METER_ML

float

Yes

ps.PumpMon.SensFlowMeter

PU_SENS_PRESS

float

Yes

ps.PumpMon.SensPressure

Example response:

{
  "BG_LEVEL_PW_CONTROL": 0,
  "BB_LEVEL_PW_CONTROL": 0,
  "BG_SENS_TEMP_A": 0,
  "BB_SENS_TEMP_A": 0,
  "PU_SENS_FLOW_METER_ML": 0,
  "PU_SENS_PRESS": 0
}

 

Method

-        GET /api/v2/language

Returns:

Attribute

Type

Required

Description

pref_lang

string

Yes

language

Example response:

{
  "pref_lang": "en"
}

 

Method

-        POST /api/v2/language

Request:

Attribute

Type

Required

Description

pref_lang

string

Yes

language

Example request:

{
  "pref_lang": "en"
}

Example response:

{
  "status": "success",
  "pref_lang": "en"
}

 

Method

-        POST /api/v2/toggle_sb

Request:

Attribute

Type

Required

Description

TOGGLE

bool

Yes

true/false

Example request:

{
  "TOGGLE": true
}

Example response:

HTTP 200

 

Method

-        POST /api/v2/inc_dec_sb

Request:

Attribute

Type

Required

Description

SB_SET_PRESS

float

Yes

0.1 or -0.1

Example request:

{
  "TOGGLE": true
}

Example response:

{
  "SB_SET_PRESS": 0.1
}

 

Method

-        POST /api/v2/inc_dec_bb

Request:

Attribute

Type

Required

Description

BB_SET_TEMP

float

Yes

0.1 or -0.1

Example request:

{
  "TOGGLE": true
}

Example response:

{
  "BB_SET_TEMP": 0.1
}

 

Method

-        POST /api/v2/inc_dec

Request:

Attribute

Type

Required

Description

BG_SET_TEMP

float

Yes

value

BG_SET_TEMP

float

Yes

value

Example request:

{
  "BG_SET_TEMP": 95.5,
  "BB_SET_TEMP": 95.5
}

Example response:

{
  "BG_SET_TEMP": 95.5,
  "BB_SET_TEMP": 95.5
}

 

Method

-        POST /api/v2/machine/control

Request:

Attribute

Type

Required

Description

action

uint8

Yes

value

Example request:

{
  "action": 1
}

Example response:

HTTP 200

 

Method

-        POST /api/v2/machine/pid

Request:

Attribute

Type

Required

Description

BG_P_VAL

float

Yes

 

BG_I_VAL

float

Yes

 

BG_D_VAL

float

Yes

 

BG_SET_SENSOR_SLOPE

float

Yes

 

BG_SET_SENSOR_OFFSET

float

Yes

 

BB_P_VAL

float

Yes

 

BB_I_VAL

float

Yes

 

BB_D_VAL

float

Yes

 

BB_SET_SENSOR_SLOPE

float

Yes

 

BB_SET_SENSOR_OFFSET

float

Yes

 

BB_OFFSET_TO_BG

float

Yes

 

PU_P_VAL

float

Yes

 

PU_I_VAL

float

Yes

 

PU_D_VAL

float

Yes

 

Example request:

{
  "BG_P_VAL": "0.00000",
  "BG_I_VAL": "0.00000",
  "BG_D_VAL": "0.00000",
  "BG_SET_SENSOR_OFFSET": "0.00000",
  "BG_SET_SENSOR_SLOPE": "0.00000",
  "BB_P_VAL": "0.00000",
  "BB_I_VAL": "0.00000",
  "BB_D_VAL": "0.00000",
  "BB_SET_SENSOR_OFFSET": "0.00000",
  "BB_SET_SENSOR_SLOPE": "0.00000",
  "BB_OFFSET_TO_BG": "0.00000",
  "PU_P_VAL": "0.00000",
  "PU_I_VAL": "0.00000",
  "PU_D_VAL": "0.00000"
}

Example response:

HTTP 200

 

Method

-        GET /api/v2/machine

Returns:

Attribute

Type

Required

Description

MA_TYPE

uint8

Yes

type of machine

MA_FIX_WATER_SUPPLY

uint8

Yes

ps.Machine.FixWaterSupply

MA_HEATUP_FLUSH_EN

uint8

Yes

ps.Machine.HeatupFlushEn

MA_SET_TIMER_ECO_MA

uint16

Yes

ps.Machine.SetTimerEcoMa

MA_SET_TIMER_POWERDOWN

uint16

Yes

ps.Machine.SetTimerPowerDown

MA_MAX_AMPERE

uint16

Yes

ps.Machine.MaxAmpere

MA_ENERGY_TOTAL_KWH

float

Yes

ps.MachineMon.EnergyTotalkwH

FW_VERSION_MAJOR

uint8

Yes

ps.MachineMon.FmVersionMajor

FW_VERSION_MINOR

uint8

Yes

ps.MachineMon.FmVersionMinor

ESP_FW_MAJOR

uint8

Yes

Webserver major version

ESP_FW_MINOR

uint8

Yes

Webserver minor version

Example response:

{
  "MA_TYPE": 0,
  "MA_FIX_WATER_SUPPLY": 0,
  "MA_HEATUP_FLUSH_EN": 0,
  "MA_SET_TIMER_ECO_MA": 12,
  "MA_SET_TIMER_POWERDOWN": 10,
  "MA_MAX_AMPERE": 10,
  "MA_ENERGY_TOTAL_KWH": 0.000144649,
  "FW_VERSION_MAJOR": 0,
  "FW_VERSION_MINOR": 0,
  "ESP_FW_MAJOR": 3,
  "ESP_FW_MINOR": 9,
  "MA_SN": "none"
}

 

Method

-        POST /api/v2/machine

Request:

Attribute

Type

Required

Description

MA_SET_TIMER_ECO_MA

uint16

Yes

 

MA_SET_TIMER_POWERDOWN

uint16

Yes

 

MA_FIX_WATER_SUPPLY

uint8

Yes

 

MA_MAX_AMPERE

uint16

Yes

 

MA_HEATUP_FLUSH_EN

uint8

Yes

 

Example request:

{
  "MA_HEATUP_FLUSH_EN": 0,
  "MA_SET_TIMER_ECO_MA": "12",
  "MA_SET_TIMER_POWERDOWN": "10",
  "MA_FIX_WATER_SUPPLY": "0",
  "MA_MAX_AMPERE": "10"
}

Example response:

HTTP 200