Skip to content

Latest commit

 

History

History
115 lines (94 loc) · 3.94 KB

websockets.md

File metadata and controls

115 lines (94 loc) · 3.94 KB

Websocket APIs

Inititate connection

ws://IP:8081/api/v1/streaming -H "Authorization: Bearer <Token>"

Messages

Statistics

[
  {
    "MachineStatistics": "{\"groups\":[{\"doses\":[{\"DoseA\":343},{\"DoseB\":0},{\"DoseC\":0},{\"DoseD\":0},{\"ContinuousDose\":0}],\"clean\":0,\"ev_activations\":1012,\"ev_ontime\":11849}],\"tot_doses\":343,\"boilers\":[{\"rsteam_ontime\":25},{\"rcoffee_ontime\":37}],\"tea\":{\"count\":0,\"ev_activation\":0,\"ev_ontime\":0},\"pump_ontime\":11660,\"machine_ontime\":2522,\"refill_ontime\":473,\"count_liter\":0}"
  }
]

SystemInfo

{
  "SystemInfo": "{\"network_interfaces\":[{\"name\":\"wlan0\",\"address\":\"192.168.x.x\",\"mac\":\"<MAC>\",\"auth\":\"WPA2_WPA3_PSK\",\"channel\":11,\"rssi\":-61}],\"system_ram\":[{\"name\":\"internal\",\"free\":48671,\"allocated\":244116},{\"name\":\"external\",\"free\":4046327,\"allocated\":380152}],\"cpu\":{\"cpu0\":14,\"cpu1\":11},\"connections\":{\"ws\":21,\"ble\":17,\"mqtt\":10,\"wifi\":3},\"up_time\":228801,\"curr_time\":\"2023-07-10 06:03:50\",\"boot_reason\":\"ESP_RST_POWERON\",\"boot_count\":0,\"timezone\":2,\"fs\":{\"total\":4096000,\"used\":16384,\"files\":[{\"path\":\"/storage/auth\",\"size\":175},{\"path\":\"/storage/cert.crt\",\"size\":1224},{\"path\":\"/storage/log.txt\",\"size\":0},{\"path\":\"/storage/private.key\",\"size\":1675}]}}"
}

Brewing Snapshot (deprecated)

[
  {
    "BrewingSnapshotGroup1": "{\"groupConfiguration\":{\"groupNumber\":\"Group1\",\"capabilities\":{\"groupType\":\"AV_Group\",\"boilerId\":\"CoffeeBoiler1\",\"boilerTemperature\":47,\"hasScale\":false,\"hasFlowmeter\":true},\"dose\":{\"doseIndex\":\"DoseA\",\"stopTarget\":0,\"doseType\":\"PulsesType\"},\"doseMode\":{\"brewingType\":\"PulsesType\"}},\"flushInfo\":{\"doseIndex\":\"DoseA\",\"stopReason\":\"Manual\",\"time\":6.7829999923706055,\"stopType\":\"Volumetric\",\"volume\":0}}"
  },
  {
    "FlushStoppedGroup1DoseIndex": "DoseA"
  },
  {
    "FlushStoppedGroup1Time": 6.783
  },
  {
    "FlushStoppedGroup1Volume": 0
  }
]

Brewing Update

[
  {
    "BrewingUpdateGroup1Time": 6.188
  },
  {
    "BrewingUpdateGroup1Ev": true
  },
  {
    "BrewingUpdateGroup1Volume": 0
  }
]

Brewing stopped

[
  { "BrewingStartedGroup1StopType": "Volume" },
  { "BrewingStartedGroup1DoseIndex": "DoseA" },
  { "BrewingStartedGroup1VolumeTarget": 0 }
]

Wake up

[
  {
    "WakeUp": "manual"
  }
]

Sleep

[
  {
    "Sleep": "command"
  }
]

Flush Snapshot

[
  {
    "FlushSnapshotGroup1": "{\"groupConfiguration\":{\"groupNumber\":\"Group1\",\"capabilities\":{\"groupType\":\"AV_Group\",\"boilerId\":\"CoffeeBoiler1\",\"boilerTemperature\":97,\"boilerTemperatureAtStart\":97,\"hasScale\":false,\"hasFlowmeter\":true},\"dose\":{\"doseIndex\":\"DoseA\",\"stopTarget\":0,\"doseType\":\"PulsesType\"},\"doseMode\":{\"brewingType\":\"PulsesType\"}},\"flushInfo\":{\"doseIndex\":\"DoseA\",\"stopReason\":\"Manual\",\"time\":4.521,\"stopType\":\"Volumetric\",\"volume\":0}}"
  },
  { "FlushStoppedGroup1DoseIndex": "DoseA" },
  { "FlushStoppedGroup1Time": 4.521 },
  { "FlushStoppedGroup1Volume": 0 }
]

Dose snapshot

[
  {
    "GroupCapabilities": "[{\"capabilities\":{\"groupType\":\"AV_Group\",\"groupNumber\":\"Group1\",\"boilerId\":\"CoffeeBoiler1\",\"hasScale\":false,\"hasFlowmeter\":true,\"numberOfDoses\":4},\"doses\":[{\"groupNumber\":\"Group1\",\"doseIndex\":\"DoseA\",\"doseType\":\"PulsesType\",\"stopTarget\":126},{\"groupNumber\":\"Group1\",\"doseIndex\":\"DoseB\",\"doseType\":\"PulsesType\",\"stopTarget\":130},{\"groupNumber\":\"Group1\",\"doseIndex\":\"DoseC\",\"doseType\":\"PulsesType\",\"stopTarget\":140},{\"groupNumber\":\"Group1\",\"doseIndex\":\"DoseD\",\"doseType\":\"PulsesType\",\"stopTarget\":77}],\"doseMode\":{\"groupNumber\":\"Group1\",\"brewingType\":\"PulsesType\"}}]"
  }
]