Automation

With the automation module, simple rules can be executed. A rule consists of an action to be executed and a condition that must be met for the action to be executed.

warp1

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/automation/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/state

{
  "registered_triggers": [1, 2, 3, 5, 6, 9, 10, 11, 18],
  "registered_actions": [1, 2, 3, 4, 5, 6, 7, 8],
  "enabled_triggers": [1, 2, 6, 11, 18, 10, 5],
  "enabled_actions": [1, 3, 4, 5, 6, 8, 7]
}

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 2 - Change of charging state Name Description old_charger_state int Charging state before transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error new_charger_state int Charging state after transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 5 - Detection of an NFC tag Name Description tag_type int Type of tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D 6 - Reaching the charging time or energy limit null: Reaching the charging time or energy limit 9 - Triggering of the external control watchdog. null: Triggering of the external control watchdog. 10 - Detection of an error by the meter monitoring null: Detection of an error by the meter monitoring 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 3 - Limit the charging current Name Description current int Charging current limit to be set 4 - Display on the front button LED Name Description indication int Blink pattern to be displayed. -1 - EVSE controls LED 0 - Off 1..254 - PWM dimmed lighting 255 - On 1001 - Confirming blink (e.g.: NFC tag was detected) 1002 - Rejecting blink (e.g.: NFC tag is unknown) 1003 - Prompting blink (e.g.: NFC tag is required for charging) 2001..2010 - Error blink 1 to 10. duration int (ms) Duration for which the set state is maintained. color_h int (°) Hue value of the LED in HSV color space. Allowed values are 0 to 359 color_s int Saturation of the LED in HSV color space. Allowed values are 0 to 255 color_v int Value (brightness) of the LED in HSV color space. A brightness of 0 uses the default color of the indication or blue for WARP1 or WARP2. Allowed values are 0 to 255 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set 7 - Simulate an NFC tag Name Description tag_type int Type of tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D action int Indicates whether the tag should only be used for starting or stopping a charging session, or for both 0 - Tag can start and stop charging sessions 0 - Tag can start charging sessions 0 - Tag can stop charging sessions 8 - Set the charging time or energy limit Name Description restart bool Indicates whether the new limits should apply relative to the existing charging session, or absolutely. For example, if a charging session has been running for 17 minutes and this action is triggered with duration = 2 (30 minutes), then if restart is false, the charging session may continue for another 13 minutes, so that a total of 30 minutes has been charged. If restart is true, it may charge for another 30 minutes, i.e. a total of 47 minutes. false - New charging limit applies relative to the running charging session. E.g. extension to 30 minutes. true - New charging limit applies absolutely. E.g. extension by 30 minutes. duration int Time limit of a charging session. After the time limit expires, the charging session is stopped. -1 - Do not change time limit 0 - Unlimited 1 - 15 minutes 2 - 30 minutes 3 - 45 minutes 4 - 1 hour 5 - 2 hours 6 - 3 hours 7 - 4 hours 8 - 6 hours 9 - 8 hours 10 - 12 hours energy_wh int (Wh) Energy limit of a charging session. After the energy limit is reached, the charging session is stopped. -1 - Do not change energy limit

warp2

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/automation/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/state

{
  "registered_triggers": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 16, 17, 18],
  "registered_actions": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14],
  "enabled_triggers": [1, 2, 4, 6, 7, 8, 11, 18, 10, 5],
  "enabled_actions": [1, 3, 4, 5, 6, 8, 9, 7]
}

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 2 - Change of charging state Name Description old_charger_state int Charging state before transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error new_charger_state int Charging state after transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 4 - Pressing the front button null: Pressing the front button 5 - Detection of an NFC tag Name Description tag_type int Type of tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D 6 - Reaching the charging time or energy limit null: Reaching the charging time or energy limit 7 - Switching of the shutdown input Name Description closed bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 8 - Switching of the configurable input Name Description closed bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 9 - Triggering of the external control watchdog. null: Triggering of the external control watchdog. 10 - Detection of an error by the meter monitoring null: Detection of an error by the meter monitoring 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 3 - Limit the charging current Name Description current int Charging current limit to be set 4 - Display on the front button LED Name Description indication int Blink pattern to be displayed. -1 - EVSE controls LED 0 - Off 1..254 - PWM dimmed lighting 255 - On 1001 - Confirming blink (e.g.: NFC tag was detected) 1002 - Rejecting blink (e.g.: NFC tag is unknown) 1003 - Prompting blink (e.g.: NFC tag is required for charging) 2001..2010 - Error blink 1 to 10. duration int (ms) Duration for which the set state is maintained. color_h int (°) Hue value of the LED in HSV color space. Allowed values are 0 to 359 color_s int Saturation of the LED in HSV color space. Allowed values are 0 to 255 color_v int Value (brightness) of the LED in HSV color space. A brightness of 0 uses the default color of the indication or blue for WARP1 or WARP2. Allowed values are 0 to 255 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set 7 - Simulate an NFC tag Name Description tag_type int Type of tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D action int Indicates whether the tag should only be used for starting or stopping a charging session, or for both 0 - Tag can start and stop charging sessions 0 - Tag can start charging sessions 0 - Tag can stop charging sessions 8 - Set the charging time or energy limit Name Description restart bool Indicates whether the new limits should apply relative to the existing charging session, or absolutely. For example, if a charging session has been running for 17 minutes and this action is triggered with duration = 2 (30 minutes), then if restart is false, the charging session may continue for another 13 minutes, so that a total of 30 minutes has been charged. If restart is true, it may charge for another 30 minutes, i.e. a total of 47 minutes. false - New charging limit applies relative to the running charging session. E.g. extension to 30 minutes. true - New charging limit applies absolutely. E.g. extension by 30 minutes. duration int Time limit of a charging session. After the time limit expires, the charging session is stopped. -1 - Do not change time limit 0 - Unlimited 1 - 15 minutes 2 - 30 minutes 3 - 45 minutes 4 - 1 hour 5 - 2 hours 6 - 3 hours 7 - 4 hours 8 - 6 hours 9 - 8 hours 10 - 12 hours energy_wh int (Wh) Energy limit of a charging session. After the energy limit is reached, the charging session is stopped. -1 - Do not change energy limit 9 - Switch the configurable output Name Description state int Indicates whether the configured output should be closed or opened. 0 - Closed (connected to ground) 1 - Open (high impedance)

warp3

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/automation/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/state

{
  "registered_triggers": [1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 16, 17, 18],
  "registered_actions": [1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 14],
  "enabled_triggers": [1, 2, 4, 6, 7, 11, 18, 3, 10, 5],
  "enabled_actions": [1, 3, 4, 5, 6, 8, 2, 7]
}

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 2 - Change of charging state Name Description old_charger_state int Charging state before transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error new_charger_state int Charging state after transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 4 - Pressing the front button null: Pressing the front button 5 - Detection of an NFC tag Name Description tag_type int Type of tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D 6 - Reaching the charging time or energy limit null: Reaching the charging time or energy limit 7 - Switching of the shutdown input Name Description closed bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 9 - Triggering of the external control watchdog. null: Triggering of the external control watchdog. 10 - Detection of an error by the meter monitoring null: Detection of an error by the meter monitoring 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 3 - Limit the charging current Name Description current int Charging current limit to be set 4 - Display on the front button LED Name Description indication int Blink pattern to be displayed. -1 - EVSE controls LED 0 - Off 1..254 - PWM dimmed lighting 255 - On 1001 - Confirming blink (e.g.: NFC tag was detected) 1002 - Rejecting blink (e.g.: NFC tag is unknown) 1003 - Prompting blink (e.g.: NFC tag is required for charging) 2001..2010 - Error blink 1 to 10. duration int (ms) Duration for which the set state is maintained. color_h int (°) Hue value of the LED in HSV color space. Allowed values are 0 to 359 color_s int Saturation of the LED in HSV color space. Allowed values are 0 to 255 color_v int Value (brightness) of the LED in HSV color space. A brightness of 0 uses the default color of the indication or blue for WARP1 or WARP2. Allowed values are 0 to 255 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set 7 - Simulate an NFC tag Name Description tag_type int Type of tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D action int Indicates whether the tag should only be used for starting or stopping a charging session, or for both 0 - Tag can start and stop charging sessions 0 - Tag can start charging sessions 0 - Tag can stop charging sessions 8 - Set the charging time or energy limit Name Description restart bool Indicates whether the new limits should apply relative to the existing charging session, or absolutely. For example, if a charging session has been running for 17 minutes and this action is triggered with duration = 2 (30 minutes), then if restart is false, the charging session may continue for another 13 minutes, so that a total of 30 minutes has been charged. If restart is true, it may charge for another 30 minutes, i.e. a total of 47 minutes. false - New charging limit applies relative to the running charging session. E.g. extension to 30 minutes. true - New charging limit applies absolutely. E.g. extension by 30 minutes. duration int Time limit of a charging session. After the time limit expires, the charging session is stopped. -1 - Do not change time limit 0 - Unlimited 1 - 15 minutes 2 - 30 minutes 3 - 45 minutes 4 - 1 hour 5 - 2 hours 6 - 3 hours 7 - 4 hours 8 - 6 hours 9 - 8 hours 10 - 12 hours energy_wh int (Wh) Energy limit of a charging session. After the energy limit is reached, the charging session is stopped. -1 - Do not change energy limit 11 - Start a phase switching Name Description phases_wanted int Indicates whether to switch to single-phase or three-phase 1 - Switch to single-phase 3 - Switch to three-phase 12 - Change the charging mode Name Description mode int Desired charging mode. See power_manager/charge_mode 0 - Fast 1 - Off 2 - PV 3 - Min + PV 14 - Limit the ???TODO??? current Name Description current int Current limit to be set -1 - Remove current limit

wem

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/automation/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/state

{
  "registered_triggers": [1, 3, 12, 13, 14, 15, 16, 17, 18],
  "registered_actions": [1, 2, 5, 11, 12, 13, 14, 15],
  "enabled_triggers": [1, 12, 13, 14, 15, 18, 3, 16, 17],
  "enabled_actions": [1, 5, 13, 15, 2, 12, 14]
}

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 12 - Switching of input 3 Name Description state bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 13 - Switching of input 4 Name Description state bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 14 - Switching of the phase switching Name Description phase int Indicates whether to react when switching to single-phase or three-phase 1 - React when switching to single-phase 3 - React when switching to three-phase 15 - Detection of an error by the contactor monitoring Name Description contactor_okay bool Indicates whether to react when a contactor error is present or not. true - React when a contactor error was detected false - React when no contactor error was detected 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set 11 - Start a phase switching Name Description phases_wanted int Indicates whether to switch to single-phase or three-phase 1 - Switch to single-phase 3 - Switch to three-phase 12 - Change the charging mode Name Description mode int Desired charging mode. See power_manager/charge_mode 0 - Fast 1 - Off 2 - PV 3 - Min + PV 13 - Switch the relay output Name Description state bool Indicates whether the relay output should be closed or opened. true - Closed false - Open 14 - Limit the ???TODO??? current Name Description current int Current limit to be set -1 - Remove current limit 15 - Block or release charging sessions Name Description slot int Blocking slot to be used. Charging sessions are only allowed if all 4 blocking slots are not blocking. block bool Indicates whether the selected blocking slot should be blocked or released false - Release selected blocking slot true - Block selected blocking slot

wem2

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set

any

automation/state

The state of the automation. Indicates which conditions and actions are supported by this firmware and which of the supported conditions and actions can currently be executed. Depending on the configuration, certain conditions and actions cannot be executed, for example, MQTT messages cannot be responded to if no MQTT connection is configured.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/automation/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/state

{
  "registered_triggers": [1, 2, 3, 5, 6, 9, 10, 11, 18],
  "registered_actions": [1, 2, 3, 4, 5, 6, 7, 8],
  "enabled_triggers": [1, 2, 6, 11, 18, 10, 5],
  "enabled_actions": [1, 3, 4, 5, 6, 8, 7]
}

Name	Description
registered_triggers int[19]	Conditions known to this firmware (union tags of the trigger of a rule from automation/config). [0..18] - A known condition.
registered_actions int[16]	Actions known to this firmware (union tags of the action of a rule from automation/config) [0..15] - A known action.
enabled_triggers int[19]	Currently executable conditions (union tags of the trigger of a rule from automation/config). Is always a subset of registered_triggers. [0..18] - An executable condition.
enabled_actions int[16]	Currently executable actions (union tags of the action of a rule from automation/config). Is always a subset of registered_actions. [0..15] - An executable action.

automation/config

The configuration of the automation.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

curl http://$HOST/automation/config -d '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

curl http://$HOST/automation/config -d '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/automation/config

{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hello World!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}

Configure two tasks:

• (Trigger 1) On weekends (wday 9), 10 minutes (minute 10) after each full hour,
  (Action 1) show Hello World! in the event log.
• (Trigger 18) When an HTTP-GET, POST or PUT request (method 4) with content "open" is received at URL http://$HOST/automation_trigger/garage_door,
  (Action 2) send MQTT message 1 to topic door/control.

Write

With MQTT on $PREFIX/automation/config_update

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '{
  "tasks": [
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]
}'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/automation/config_update -m '[
    {
      "trigger": [1, { "mday": -1, "wday": 9, "hour": -1, "minute": 10 }],
      "action": [1, { "message": "Hallo Welt!" }]
    },
    {
      "trigger": [
        18,
        { "method": 4, "url_suffix": "garage_door", "payload": "open" }
      ],
      "action": [
        2,
        {
          "topic": "door/control",
          "payload": "1",
          "retain": false,
          "use_prefix": false
        }
      ]
    }
  ]'

Name

Description

tasks object[14]

Configured rules [0..13] - An automation rule Name Description trigger Union Condition that must be met for the action to be executed 0 - No condition configured. null: No condition configured. 1 - At a specific time. Name Description mday int Day of month (1 to 31 or -1, 0, 32) -1 - Every day of the month 0 - Every day of the month 32 - Last day of the month wday int Weekday -1 - Every day of the week 0 - Sunday 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sunday 8 - Weekdays (Monday to Friday) 9 - On weekends (Saturday and Sunday) hour int Hour of day (0 to 23 or -1) -1 - Hourly minute int Minute of day (0 to 59 or -1) -1 - Every minute 2 - Change of charging state Name Description old_charger_state int Charging state before transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error new_charger_state int Charging state after transition -1 - Any charging state 0 - Vehicle disconnected 1 - Waiting for release 2 - Ready to charge 3 - Charging 4 - Error 3 - Receipt of an MQTT message Name Description topic_filter string MQTT topic filter to wait for messages with. payload string Payload that should be contained in the message retain bool Indicates whether to react to retained packets use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 4 - Pressing the front button null: Pressing the front button 5 - Detection of an NFC tag Name Description tag_type int Type of tag 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D 6 - Reaching the charging time or energy limit null: Reaching the charging time or energy limit 7 - Switching of the shutdown input Name Description closed bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 8 - Switching of the configurable input Name Description closed bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 9 - Triggering of the external control watchdog. null: Triggering of the external control watchdog. 10 - Detection of an error by the meter monitoring null: Detection of an error by the meter monitoring 11 - Triggering of the load management watchdog. null: Triggering of the load management watchdog. 12 - Switching of input 3 Name Description state bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 13 - Switching of input 4 Name Description state bool Indicates whether to react when the input is open or closed true - React when input is open false - React when input is closed 14 - Switching of the phase switching Name Description phase int Indicates whether to react when switching to single-phase or three-phase 1 - React when switching to single-phase 3 - React when switching to three-phase 15 - Detection of an error by the contactor monitoring Name Description contactor_okay bool Indicates whether to react when a contactor error is present or not. true - React when a contactor error was detected false - React when no contactor error was detected 16 - Power available TODO Name Description power_available bool Indicates whether to react when power is available or not available. true - React when power is available false - React when no power is available 17 - Measurement of grid consumption or feed-in Name Description drawing_power bool Indicates whether to react when power is fed into the grid or drawn from the grid. true - React when power is drawn false - React when power is fed in 18 - Receipt of an HTTP request Name Description method int Indicates which HTTP methods to react to 0 - React to GET 1 - React to POST 2 - React to PUT 3 - React to POST and PUT 4 - React to GET, POST and PUT url_suffix string URL suffix on which HTTP requests are waited for. Is appended to http://[hostname]/automation_trigger/. payload string Payload that must be contained in the HTTP request for the rule to trigger. May be empty (especially for HTTP GET). action Union Action to be executed 0 - No action configured. null: No action configured. 1 - Write to event log Name Description message string Message to be written to the event log 2 - Send an MQTT message Name Description topic string MQTT topic to which the message should be sent. payload string Payload that should be contained in the message retain bool Indicates whether the message should be retained use_prefix bool Indicates whether the configured global topic prefix (see mqtt/config) should be prepended to the configured topic. 3 - Limit the charging current Name Description current int Charging current limit to be set 4 - Display on the front button LED Name Description indication int Blink pattern to be displayed. -1 - EVSE controls LED 0 - Off 1..254 - PWM dimmed lighting 255 - On 1001 - Confirming blink (e.g.: NFC tag was detected) 1002 - Rejecting blink (e.g.: NFC tag is unknown) 1003 - Prompting blink (e.g.: NFC tag is required for charging) 2001..2010 - Error blink 1 to 10. duration int (ms) Duration for which the set state is maintained. color_h int (°) Hue value of the LED in HSV color space. Allowed values are 0 to 359 color_s int Saturation of the LED in HSV color space. Allowed values are 0 to 255 color_v int Value (brightness) of the LED in HSV color space. A brightness of 0 uses the default color of the indication or blue for WARP1 or WARP2. Allowed values are 0 to 255 5 - Reset an electricity meter Name Description meter_slot int Meter slot ID of the meter to be reset 6 - Set the current available for the load manager. Name Description current int Available current to be set 7 - Simulate an NFC tag Name Description tag_type int Type of tag. 0 - Mifare Classic 1 - NFC Forum Type 1 2 - NFC Forum Type 2 3 - NFC Forum Type 3 4 - NFC Forum Type 4 tag_id string ID of the tag. Up to 10 hex bytes depending on tag type, separated by ':'. e.g. 01:23:AB:3D action int Indicates whether the tag should only be used for starting or stopping a charging session, or for both 0 - Tag can start and stop charging sessions 0 - Tag can start charging sessions 0 - Tag can stop charging sessions 8 - Set the charging time or energy limit Name Description restart bool Indicates whether the new limits should apply relative to the existing charging session, or absolutely. For example, if a charging session has been running for 17 minutes and this action is triggered with duration = 2 (30 minutes), then if restart is false, the charging session may continue for another 13 minutes, so that a total of 30 minutes has been charged. If restart is true, it may charge for another 30 minutes, i.e. a total of 47 minutes. false - New charging limit applies relative to the running charging session. E.g. extension to 30 minutes. true - New charging limit applies absolutely. E.g. extension by 30 minutes. duration int Time limit of a charging session. After the time limit expires, the charging session is stopped. -1 - Do not change time limit 0 - Unlimited 1 - 15 minutes 2 - 30 minutes 3 - 45 minutes 4 - 1 hour 5 - 2 hours 6 - 3 hours 7 - 4 hours 8 - 6 hours 9 - 8 hours 10 - 12 hours energy_wh int (Wh) Energy limit of a charging session. After the energy limit is reached, the charging session is stopped. -1 - Do not change energy limit 9 - Switch the configurable output Name Description state int Indicates whether the configured output should be closed or opened. 0 - Closed (connected to ground) 1 - Open (high impedance) 11 - Start a phase switching Name Description phases_wanted int Indicates whether to switch to single-phase or three-phase 1 - Switch to single-phase 3 - Switch to three-phase 12 - Change the charging mode Name Description mode int Desired charging mode. See power_manager/charge_mode 0 - Fast 1 - Off 2 - PV 3 - Min + PV 13 - Switch the relay output Name Description state bool Indicates whether the relay output should be closed or opened. true - Closed false - Open 14 - Limit the ???TODO??? current Name Description current int Current limit to be set -1 - Remove current limit 15 - Block or release charging sessions Name Description slot int Blocking slot to be used. Charging sessions are only allowed if all 4 blocking slots are not blocking. block bool Indicates whether the selected blocking slot should be blocked or released false - Release selected blocking slot true - Block selected blocking slot