MQTT protocol / API

Tech
, , , ,
#1

MQTT Events

  • HA discovery config
  • Device Status
  • Electricity State
  • Device Progress
  • Device Logs

Home Assistant Discovery Config

Sensors:

  • total imported energy (Wh as “Wh”)
  • three-phase imported active power (W as “W”)
  • total exported energy (Wh as “Ph”)
  • three-phase exported active power (W as “P”)
  • total imported reactive energy (Wh as “Rh”)
  • three-phase imported reactive power (W as “R”)
  • total exported reactive energy (Wh as “Qh”)
  • three-phase exported reactive power (W as “Q”)
  • L1…L3 imported active power (W as “L1”)
  • L1…L3 voltage (V as “U1”)
  • L1…L3 current (A as “I2”)
  • L1…L3 exported active power (W as “P1”)
  • L1…L3 imported reactive power (VAr as “R1”)
  • L1…L3 exported reactive power (VAr as “Q1”)

Example Sequence

topic {payload}

homeassistant/sensor/blink_80aa1879cf58/config {"uniq_id":"blink_80aa1879cf58","obj_id":"blink_80aa1879cf58","name":"Currently Blink Power","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.bW}}"}
homeassistant/sensor/bWh_80aa1879cf58/config {"uniq_id":"bWh_80aa1879cf58","obj_id":"bWh_80aa1879cf58","name":"Currently imps","dev_cla":"energy","stat_cla":"total_increasing","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"Wh","val_tpl":"{{value_json.bWh}}"}
homeassistant/sensor/boot_80aa1879cf58/config {"uniq_id":"boot_80aa1879cf58","obj_id":"boot_80aa1879cf58","name":"Currently Boot","dev_cla":"timestamp","stat_t":"currently/one/80aa1879cf58/config","val_tpl":"{{value_json.t}}","init":"2023-10-11T06:22:29+0200"}
homeassistant/sensor/total_floor_fan/config {"uniq_id":"total_floor_fan","obj_id":"total_floor_fan","name":"Floor Fan 80aa used","dev_cla":"energy","stat_t":"currently/one/floor_fan/detect","stat_cla":"total_increasing","unit_of_meas":"Wh","val_tpl":"{{value_json.Wh}}"}
homeassistant/sensor/power_floor_fan/config {"uniq_id":"power_floor_fan","obj_id":"power_floor_fan","name":"Floor Fan 80aa power","dev_cla":"power","stat_t":"currently/one/floor_fan/detect","unit_of_meas":"W","val_tpl":"{{value_json.W}}"}
homeassistant/sensor/total_wine_cool/config {"uniq_id":"total_wine_cool","obj_id":"total_wine_cool","name":"Wine Cool 80aa used","dev_cla":"energy","stat_t":"currently/one/wine_cool/detect","stat_cla":"total_increasing","unit_of_meas":"Wh","val_tpl":"{{value_json.Wh}}"}
homeassistant/sensor/power_wine_cool/config {"uniq_id":"power_wine_cool","obj_id":"power_wine_cool","name":"Wine Cool 80aa power","dev_cla":"power","stat_t":"currently/one/wine_cool/detect","unit_of_meas":"W","val_tpl":"{{value_json.W}}"}
homeassistant/sensor/csW_80aa1879cf58/config 

currently/one/80aa1879cf58/status online
homeassistant/sensor/time_80aa1879cf58/config {"uniq_id":"time_80aa1879cf58","obj_id":"time_80aa1879cf58","name":"Currently Seen","dev_cla":"timestamp","stat_t":"currently/one/80aa1879cf58/state","val_tpl":"{{value_json.t}}"}
homeassistant/sensor/power_80aa1879cf58/config {"uniq_id":"power_80aa1879cf58","obj_id":"power_80aa1879cf58","name":"Currently Using","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.W}}"}
homeassistant/sensor/total_80aa1879cf58/config {"uniq_id":"total_80aa1879cf58","obj_id":"total_80aa1879cf58","name":"Currently Used","dev_cla":"energy","stat_cla":"total_increasing","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"Wh","val_tpl":"{{value_json.Wh}}"}
homeassistant/sensor/Qh_80aa1879cf58/config {"uniq_id":"Qh_80aa1879cf58","obj_id":"Qh_80aa1879cf58","name":"Currently Reactive Returned","dev_cla":"energy","stat_cla":"total_increasing","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"Wh","val_tpl":"{{value_json.Qh}}"}
homeassistant/sensor/Rh_80aa1879cf58/config {"uniq_id":"Rh_80aa1879cf58","obj_id":"Rh_80aa1879cf58","name":"Currently Reactive Used","dev_cla":"energy","stat_cla":"total_increasing","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"Wh","val_tpl":"{{value_json.Rh}}"}
homeassistant/sensor/Q_80aa1879cf58/config {"uniq_id":"Q_80aa1879cf58","obj_id":"Q_80aa1879cf58","name":"Currently Reactive Returning","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.Q}}"}
homeassistant/sensor/R_80aa1879cf58/config {"uniq_id":"R_80aa1879cf58","obj_id":"R_80aa1879cf58","name":"Currently Reactive","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.R}}"}
homeassistant/sensor/return_80aa1879cf58/config {"uniq_id":"return_80aa1879cf58","obj_id":"return_80aa1879cf58","name":"Currently Returning","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.P}}"}
homeassistant/sensor/returned_80aa1879cf58/config {"uniq_id":"returned_80aa1879cf58","obj_id":"returned_80aa1879cf58","name":"Currently Returned","dev_cla":"energy","stat_cla":"total_increasing","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"Wh","val_tpl":"{{value_json.Ph}}"}
homeassistant/sensor/Q3_80aa1879cf58/config {"uniq_id":"Q3_80aa1879cf58","obj_id":"Q3_80aa1879cf58","name":"Currently Q3","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.Q3}}"}
homeassistant/sensor/Q2_80aa1879cf58/config {"uniq_id":"Q2_80aa1879cf58","obj_id":"Q2_80aa1879cf58","name":"Currently Q2","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.Q2}}"}
homeassistant/sensor/Q1_80aa1879cf58/config {"uniq_id":"Q1_80aa1879cf58","obj_id":"Q1_80aa1879cf58","name":"Currently Q1","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.Q1}}"}
homeassistant/sensor/R3_80aa1879cf58/config {"uniq_id":"R3_80aa1879cf58","obj_id":"R3_80aa1879cf58","name":"Currently R3","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.R3}}"}
homeassistant/sensor/R2_80aa1879cf58/config {"uniq_id":"R2_80aa1879cf58","obj_id":"R2_80aa1879cf58","name":"Currently R2","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.R2}}"}
homeassistant/sensor/R1_80aa1879cf58/config {"uniq_id":"R1_80aa1879cf58","obj_id":"R1_80aa1879cf58","name":"Currently R1","dev_cla":"reactive_power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"var","val_tpl":"{{value_json.R1}}"}
homeassistant/sensor/P3_80aa1879cf58/config {"uniq_id":"P3_80aa1879cf58","obj_id":"P3_80aa1879cf58","name":"Currently P3","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.P3}}"}
homeassistant/sensor/P2_80aa1879cf58/config {"uniq_id":"P2_80aa1879cf58","obj_id":"P2_80aa1879cf58","name":"Currently P2","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.P2}}"}
homeassistant/sensor/P1_80aa1879cf58/config {"uniq_id":"P1_80aa1879cf58","obj_id":"P1_80aa1879cf58","name":"Currently P1","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.P1}}"}
homeassistant/sensor/I3_80aa1879cf58/config {"uniq_id":"I3_80aa1879cf58","obj_id":"I3_80aa1879cf58","name":"Currently I3","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"A","val_tpl":"{{value_json.I3}}"}
homeassistant/sensor/I2_80aa1879cf58/config {"uniq_id":"I2_80aa1879cf58","obj_id":"I2_80aa1879cf58","name":"Currently I2","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"A","val_tpl":"{{value_json.I2}}"}
homeassistant/sensor/I1_80aa1879cf58/config {"uniq_id":"I1_80aa1879cf58","obj_id":"I1_80aa1879cf58","name":"Currently I1","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"A","val_tpl":"{{value_json.I1}}"}
homeassistant/sensor/U3_80aa1879cf58/config {"uniq_id":"U3_80aa1879cf58","obj_id":"U3_80aa1879cf58","name":"Currently U3","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"V","val_tpl":"{{value_json.U3}}"}
homeassistant/sensor/U2_80aa1879cf58/config {"uniq_id":"U2_80aa1879cf58","obj_id":"U2_80aa1879cf58","name":"Currently U2","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"V","val_tpl":"{{value_json.U2}}"}
homeassistant/sensor/U1_80aa1879cf58/config {"uniq_id":"U1_80aa1879cf58","obj_id":"U1_80aa1879cf58","name":"Currently U1","dev_cla":"current","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"V","val_tpl":"{{value_json.U1}}"}
homeassistant/sensor/L3_80aa1879cf58/config {"uniq_id":"L3_80aa1879cf58","obj_id":"L3_80aa1879cf58","name":"Currently L3","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.L3}}"}
homeassistant/sensor/L2_80aa1879cf58/config {"uniq_id":"L2_80aa1879cf58","obj_id":"L2_80aa1879cf58","name":"Currently L2","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.L2}}"}
homeassistant/sensor/L1_80aa1879cf58/config {"uniq_id":"L1_80aa1879cf58","obj_id":"L1_80aa1879cf58","name":"Currently L1","dev_cla":"power","stat_t":"currently/one/80aa1879cf58/state","unit_of_meas":"W","val_tpl":"{{value_json.L1}}"}
currently/one/80aa1879cf58/config {"id":"80aa1879cf58","v":"2.1.3","m":"ALL","stat_t":"currently/one/80aa1879cf58/state","cmd_t":"currently/one/80aa1879cf58/cmd","t":"2023-10-11T06:22:29+0200","rr":"POWERON","progress_t":"currently/one/80aa1879cf58/progress","rssi":"-68","txPwr":"20"}

currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:22:30+0100","W":305,"Wh":2915901,"Ph":0,"Rh":416120,"Qh":1388725,"P":0,"R":0,"Q":368,"L1":207,"P1":0,"R1":0,"Q1":225,"I1":1.300,"U1":232.500,"L2":71,"P2":0,"R2":0,"Q2":108,"I2":0.500,"U2":233.500,"L3":26,"P3":0,"R3":0,"Q3":34,"I3":0.100,"U3":235.200,"sec":1696998151}
currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:22:40+0100","W":308,"Wh":2915901,"Ph":0,"Rh":416120,"Qh":1388726,"P":0,"R":0,"Q":370,"L1":210,"P1":0,"R1":0,"Q1":227,"I1":1.300,"U1":232.700,"L2":71,"P2":0,"R2":0,"Q2":107,"I2":0.500,"U2":233.300,"L3":26,"P3":0,"R3":0,"Q3":34,"I3":0.100,"U3":235.000,"sec":1696998161}
currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:22:50+0100","W":307,"Wh":2915902,"Ph":0,"Rh":416120,"Qh":1388727,"P":0,"R":0,"Q":368,"L1":209,"P1":0,"R1":0,"Q1":225,"I1":1.300,"U1":232.500,"L2":71,"P2":0,"R2":0,"Q2":107,"I2":0.500,"U2":233.500,"L3":26,"P3":0,"R3":0,"Q3":35,"I3":0.100,"U3":235.000,"sec":1696998170}
currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:23:00+0100","W":308,"Wh":2915903,"Ph":0,"Rh":416120,"Qh":1388728,"P":0,"R":0,"Q":367,"L1":209,"P1":0,"R1":0,"Q1":224,"I1":1.300,"U1":232.200,"L2":71,"P2":0,"R2":0,"Q2":107,"I2":0.500,"U2":233.500,"L3":26,"P3":0,"R3":0,"Q3":34,"I3":0.100,"U3":235.100,"sec":1696998180}
currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:23:10+0100","W":304,"Wh":2915904,"Ph":0,"Rh":416120,"Qh":1388729,"P":0,"R":0,"Q":367,"L1":206,"P1":0,"R1":0,"Q1":225,"I1":1.300,"U1":232.300,"L2":71,"P2":0,"R2":0,"Q2":107,"I2":0.500,"U2":233.200,"L3":26,"P3":0,"R3":0,"Q3":34,"I3":0.100,"U3":235.000,"sec":1696998190,"dW":-1,"dR":1,"dL1":-1,"dR1":0,"dR2":1}
currently/one/80aa1879cf58/state {"m":"HAN","hc":true,"t":"2023-10-11T05:23:20+0100","W":258,"Wh":2915905,"Ph":0,"Rh":416120,"Qh":1388730,"P":0,"R":0,"Q":410,"L1":206,"P1":0,"R1":0,"Q1":226,"I1":1.300,"U1":232.500,"L2":25,"P2":0,"R2":0,"Q2":148,"I2":0.600,"U2":233.600,"L3":26,"P3":0,"R3":0,"Q3":34,"I3":0.100,"U3":235.000,"sec":1696998201,"dR3":0}
currently/one/80aa1879cf58/status offline

Sensor discovery config template

Topic: homeassistant/sensor/{prefix}_{deviceId}/config
Payload:

{
  "uniq_id": "{prefix}_{deviceId}",
  "obj_id": "{prefix}_{deviceId}",
  "name": "{SensorName}",
  "dev_cla": "energy|power|reactive_power|current|voltage|timestamp",
  "stat_cla": "total_increasing",
  "stat_t": "currently/one/80aa1879cf58/state",
  "unit_of_meas": "Wh|W|VAr|A|V",
  "device": {
    "identifiers": [
      "C1_80aa1879cf58"
    ],
    "name": "Currently One 80aa1879cf58",
    "model": "Currently One",
    "manufacturer": "Stopgap AB",
    "sw_version": "2.1.9"
  }
  "val_tpl": "{{value_json.{field}}}"
}

Read more about device reference in Sensors and Devices in streamed data

total imported energy (Wh)

Topic: homeassistant/sensor/total_80aa1879cf58/config
Payload:

{
  "uniq_id": "total_80aa1879cf58",
  "obj_id": "total_80aa1879cf58",
  "name": "Currently Used",
  "dev_cla": "energy",
  "stat_cla": "total_increasing",
  "stat_t": "currently/one/80aa1879cf58/state",
  "unit_of_meas": "Wh",
  "val_tpl": "{{value_json.Wh}}"
}

total imported active power (W)

Topic: homeassistant/sensor/power_80aa1879cf58/config

{
  "uniq_id": "power_80aa1879cf58",
  "obj_id": "power_80aa1879cf58",
  "name": "Currently Using",
  "dev_cla": "power",
  "stat_t": "currently/one/80aa1879cf58/state",
  "unit_of_meas": "W",
  "val_tpl": "{{value_json.W}}"
}

L1…L3 imported active power (W)

Topic: homeassistant/sensor/L1_80aa1879cf58/config

{
  "uniq_id": "L1_80aa1879cf58",
  "obj_id": "L1_80aa1879cf58",
  "name": "Currently L1",
  "dev_cla": "power",
  "stat_t": "currently/one/80aa1879cf58/state",
  "unit_of_meas": "W",
  "val_tpl": "{{value_json.L1}}"
}

L1…L3 current (A)

Topic: homeassistant/sensor/I3_80aa1879cf58/config

{
  "uniq_id": "I3_80aa1879cf58",
  "obj_id": "I3_80aa1879cf58",
  "name": "Currently I3",
  "dev_cla": "current",
  "stat_t": "currently/one/80aa1879cf58/state",
  "unit_of_meas": "A",
  "val_tpl": "{{value_json.I3}}"
}

Device Status

Topic: currently/one/80aa1879cf58/status
Payload: online or offline

Electricity State

Topic: currently/one/80aa1879cf58/state
Payload:

{
  "m": "HAN",
  "hc": true,
  "t": "2023-10-10T15:26:40+0100",
  "W": 380,
  "Wh": 2900259,
  "Ph": 0,
  "Rh": 412692,
  "Qh": 1384165,
  "P": 0,
  "R": 0,
  "Q": 385,
  "L1": 227,
  "P1": 0,
  "R1": 0,
  "Q1": 211,
  "I1": 1.300,
  "U1": 232.800,
  "L2": 129,
  "P2": 0,
  "R2": 0,
  "Q2": 140,
  "I2": 0.800,
  "U2": 233.300,
  "L3": 22,
  "P3": 0,
  "R3": 0,
  "Q3": 32,
  "I3": 0.100,
  "U3": 236.400,
  "sec": 1696948000
}

Extra fields in state JSON

name type example comment
dW int -108 three-phase active power actual delta
dR int -18 three-phase reactive power actual delta
dL2 int 42 phase 2 active power actual delta
dR3 int -55 phase 3 reactive power actual delta
Device REST API
EventSource API
Supported interfaces
[Åtgärdad] Vattenfall S34U18
Vad innebär MQTT broker?
Home Assistant statistik sensor ström
#2

For those of us not using HomeAssistant, I’m using openHAB, I have set-up a Mosquitto broker which the Currently One now is sending topics to every 5s.
I can see this being reported:

currently/one/d0dd1e79cf58/state {"m":"HAN","W":1464,"Wh":801211,"t":"2024-02-03T16:12:10+0100","Ph":0,"Rh":197394,"Qh":11427,"P":0,"R":0,"Q":201,"L1":346,"P1":0,"R1":0,"Q1":178,"I1":1.900,"U1":233.600,"L2":1106,"P2":0,"R2":17,"Q2":0,"I2":4.900,"U2":231.400,"L3":11,"P3":0,"R3":0,"Q3":39,"I3":0.100,"U3":231.700,"sec":1706973130}

Is there an explanation to these values anywhere?

  • L1
  • P1
  • R1
  • Q1
  • I1

etc.
and also how they are related.

My plan is then to integrate Currently One to openHAB using openHABs MQTT binding.
FLASH: There seems to be an integration towards HomeAsistant MQTT in openHAB:

That integration works great in openHAB:

image
image1920×1087 95.1 KB

BR

/Janne

#3

Hej Janne,
du borde kunna hitta infon på MQTT protocol / API, om du saknar någon info får vi bättra på den topic:en!

Hälsningar
Ola på Currently

#4

RTFM :slight_smile:

Sorry, hur kunde jag missa det.
Tack för en grym produkt! :slight_smile:

1 Like