Energy Manager Configuration

The energy_manager module manages the state and configuration of the WARP Energy Manager Bricklet.

warp1

Not supported on this hardware!

warp2

Not supported on this hardware!

warp3

Not supported on this hardware!

warp4

Not supported on this hardware!

wem

energy_manager/config

Energy Manager configuration

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/energy_manager/config

{ "contactor_installed": true }

Write

curl http://$HOST/energy_manager/config -d '{ "contactor_installed": true }'

or abbreviated:

curl http://$HOST/energy_manager/config -d 'true'

MQTT (mosquitto)

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

Read

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

{ "contactor_installed": true }

Write

With MQTT on $PREFIX/energy_manager/config_update

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m '{ "contactor_installed": true }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m 'true'

Name	Description
contactor_installed bool	Indicates whether a contactor is connected that can switch the controlled chargers between three-phase and single-phase operation. Input 4 is then automatically used for contactor monitoring.

energy_manager/state

Energy Manager state

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/energy_manager/state

MQTT (mosquitto)

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

Read

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

{
  "phases_switched": 1,
  "input3_state": false,
  "input4_state": false,
  "relay_state": false,
  "error_flags": 0,
  "config_error_flags": 0
}

Name	Description
phases_switched int	Phase switching state 1 - One phase connected 3 - Three phases connected
input3_state bool	State of input 3 true - Input closed false - Input open
input4_state bool	State of input 4 true - Input closed false - Input open
relay_state bool	State of the relay true - Relay closed false - Relay open
error_flags int	Active error states of the Energy Manager. This is a bitmask, so any combination of error values can occur. 0 - No error 0x00000002 - No network connection (LAN/WLAN) 0x00010000 - Contactor monitoring has triggered 0x01000000 - Internal error, Bricklet not reachable 0x02000000 - Internal error, SD card error 0x80000000 - Invalid configuration, details in config_error_flags
config_error_flags int	Active configuration errors of the Energy Manager. This is a bitmask, so any combination of configuration errors can occur. 0 - No error 0x00000001 - Phase switching or contactor not configured 0x00000002 - Maximum total current of chargers not configured 0x00000004 - No chargers configured 0x00000008 - Excess charging enabled but no electricity meter configured

energy_manager/low_level_state

Low-level state of the Energy Manager

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/energy_manager/low_level_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/low_level_state

{
  "consecutive_bricklet_errors": 0,
  "contactor": false,
  "contactor_check_state": 1,
  "input_voltage": 11925,
  "led_rgb": [0, 0, 0],
  "uptime": 940868435
}

Name	Description
consecutive_bricklet_errors int	Number of consecutive internal communication errors
contactor bool	Contactor state set by the Energy Manager true - Contactor closed false - Contactor open
contactor_check_state int	Contactor check state 0 - Contactor monitoring has triggered (contactor defective) 1 - No contactor error known (contactor OK)
input_voltage int (mV)	Internal supply voltage in millivolts.
led_rgb int[3]	Status LED color [0] - Red: 0 (off) to 255 (maximum intensity) [1] - Green: 0 (off) to 255 (maximum intensity) [2] - Blue: 0 (off) to 255 (maximum intensity)
uptime int (ms)	Time since starting the Energy Manager Bricklet. Attention: This time is measured directly via the processor clock. The accuracy is therefore only sufficient for time measurements in the range of minutes to a few hours. The time measurement overflows after approximately 50 days and starts again at 0.

energy_manager/sdcard_state

Information about the inserted MicroSD card.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/energy_manager/sdcard_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/sdcard_state

{
  "sd_status": 0,
  "lfs_status": 0,
  "card_type": 12,
  "sector_count": 15759360,
  "sector_size": 512,
  "manufacturer_id": 116,
  "product_rev": 32,
  "product_name": "USDU1"
}

Name	Description
sd_status int	SD card status 0 - OK 1 - READ_BLOCK_TIMEOUT 2 - WRITE_BLOCK_TIMEOUT 3 - RESPONSE_TIMEOUT 11 - ERROR_INIT_TYPE 12 - ERROR_INIT_VER_OR_VOLTAGE 13 - ERROR_INIT_ACMD41 14 - ERROR_INIT_CMD58 15 - ERROR_INIT_CMD0 21 - ERROR_CID_START 22 - ERROR_CID_CMD10 31 - ERROR_CSD_START 32 - ERROR_CSD_CMD9 41 - ERROR_COUNT_TO_HIGH 51 - ERROR_NO_CARD 255 - ERROR_API_FAILURE
lfs_status int	Status of the file system (LittleFS) on the SD card 0 - OK 255 - ERROR_API_FAILURE 256 - SD card is being formatted
card_type int	SD card type 0 - No SD card found 1 - MMC 2 - SD 4 - SDSC 12 - SDHC/SDXC
sector_count int	SD card size in sectors
sector_size int	Size of a sector
manufacturer_id int	Manufacturer ID
product_rev int	Product revision
product_name string	Product name

energy_manager/sdcard_format

Formats the inserted SD card and thus deletes the energy balance history. Cannot be undone! A restart is automatically performed afterwards.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Write

curl http://$HOST/energy_manager/sdcard_format -d '{ "do_i_know_what_i_am_doing": false }'

MQTT (mosquitto)

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

Write

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/sdcard_format -m '{ "do_i_know_what_i_am_doing": false }'

Name	Description
do_i_know_what_i_am_doing bool	Indicates whether the SD card should be formatted true - Format SD card false - Perform no action

wem2

energy_manager/config

Energy Manager configuration

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/energy_manager/config

{ "contactor_installed": true }

Write

curl http://$HOST/energy_manager/config -d '{ "contactor_installed": true }'

or abbreviated:

curl http://$HOST/energy_manager/config -d 'true'

MQTT (mosquitto)

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

Read

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

{ "contactor_installed": true }

Write

With MQTT on $PREFIX/energy_manager/config_update

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m '{ "contactor_installed": true }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m 'true'

Name	Description
contactor_installed bool	Indicates whether a contactor is connected that can switch the controlled chargers between three-phase and single-phase operation. Input 4 is then automatically used for contactor monitoring.

energy_manager/state

Energy Manager state

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/energy_manager/state

MQTT (mosquitto)

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

Read

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

{
  "phases_switched": 1,
  "input3_state": false,
  "input4_state": false,
  "relay_state": false,
  "error_flags": 0,
  "config_error_flags": 0
}

Name	Description
phases_switched int	Phase switching state 1 - One phase connected 3 - Three phases connected
input3_state bool	State of input 3 true - Input closed false - Input open
input4_state bool	State of input 4 true - Input closed false - Input open
relay_state bool	State of the relay true - Relay closed false - Relay open
error_flags int	Active error states of the Energy Manager. This is a bitmask, so any combination of error values can occur. 0 - No error 0x00000002 - No network connection (LAN/WLAN) 0x00010000 - Contactor monitoring has triggered 0x01000000 - Internal error, Bricklet not reachable 0x02000000 - Internal error, SD card error 0x80000000 - Invalid configuration, details in config_error_flags
config_error_flags int	Active configuration errors of the Energy Manager. This is a bitmask, so any combination of configuration errors can occur. 0 - No error 0x00000001 - Phase switching or contactor not configured 0x00000002 - Maximum total current of chargers not configured 0x00000004 - No chargers configured 0x00000008 - Excess charging enabled but no electricity meter configured

energy_manager/low_level_state

Low-level state of the Energy Manager

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/energy_manager/low_level_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/low_level_state

{
  "consecutive_bricklet_errors": 0,
  "contactor": false,
  "contactor_check_state": 1,
  "input_voltage": 11925,
  "led_rgb": [0, 0, 0],
  "uptime": 940868435
}

Name	Description
consecutive_bricklet_errors int	Number of consecutive internal communication errors
contactor bool	Contactor state set by the Energy Manager true - Contactor closed false - Contactor open
contactor_check_state int	Contactor check state 0 - Contactor monitoring has triggered (contactor defective) 1 - No contactor error known (contactor OK)
input_voltage int (mV)	Internal supply voltage in millivolts.
led_rgb int[3]	Status LED color [0] - Red: 0 (off) to 255 (maximum intensity) [1] - Green: 0 (off) to 255 (maximum intensity) [2] - Blue: 0 (off) to 255 (maximum intensity)
uptime int (ms)	Time since starting the Energy Manager Bricklet. Attention: This time is measured directly via the processor clock. The accuracy is therefore only sufficient for time measurements in the range of minutes to a few hours. The time measurement overflows after approximately 50 days and starts again at 0.

energy_manager/sdcard_state

Information about the inserted MicroSD card.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/energy_manager/sdcard_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/sdcard_state

{
  "sd_status": 0,
  "lfs_status": 0,
  "card_type": 12,
  "sector_count": 15759360,
  "sector_size": 512,
  "manufacturer_id": 116,
  "product_rev": 32,
  "product_name": "USDU1"
}

Name	Description
sd_status int	SD card status 0 - OK 1 - READ_BLOCK_TIMEOUT 2 - WRITE_BLOCK_TIMEOUT 3 - RESPONSE_TIMEOUT 11 - ERROR_INIT_TYPE 12 - ERROR_INIT_VER_OR_VOLTAGE 13 - ERROR_INIT_ACMD41 14 - ERROR_INIT_CMD58 15 - ERROR_INIT_CMD0 21 - ERROR_CID_START 22 - ERROR_CID_CMD10 31 - ERROR_CSD_START 32 - ERROR_CSD_CMD9 41 - ERROR_COUNT_TO_HIGH 51 - ERROR_NO_CARD 255 - ERROR_API_FAILURE
lfs_status int	Status of the file system (LittleFS) on the SD card 0 - OK 255 - ERROR_API_FAILURE 256 - SD card is being formatted
card_type int	SD card type 0 - No SD card found 1 - MMC 2 - SD 4 - SDSC 12 - SDHC/SDXC
sector_count int	SD card size in sectors
sector_size int	Size of a sector
manufacturer_id int	Manufacturer ID
product_rev int	Product revision
product_name string	Product name

energy_manager/sdcard_format

Formats the inserted SD card and thus deletes the energy balance history. Cannot be undone! A restart is automatically performed afterwards.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Write

curl http://$HOST/energy_manager/sdcard_format -d '{ "do_i_know_what_i_am_doing": false }'

MQTT (mosquitto)

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

Write

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/sdcard_format -m '{ "do_i_know_what_i_am_doing": false }'

Name	Description
do_i_know_what_i_am_doing bool	Indicates whether the SD card should be formatted true - Format SD card false - Perform no action

any

energy_manager/config

Energy Manager configuration

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/energy_manager/config

{ "contactor_installed": true }

Write

curl http://$HOST/energy_manager/config -d '{ "contactor_installed": true }'

or abbreviated:

curl http://$HOST/energy_manager/config -d 'true'

MQTT (mosquitto)

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

Read

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

{ "contactor_installed": true }

Write

With MQTT on $PREFIX/energy_manager/config_update

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m '{ "contactor_installed": true }'

or abbreviated:

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/config_update -m 'true'

Name	Description
contactor_installed bool	Indicates whether a contactor is connected that can switch the controlled chargers between three-phase and single-phase operation. Input 4 is then automatically used for contactor monitoring.

energy_manager/state

Energy Manager state

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/energy_manager/state

MQTT (mosquitto)

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

Read

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

{
  "phases_switched": 1,
  "input3_state": false,
  "input4_state": false,
  "relay_state": false,
  "error_flags": 0,
  "config_error_flags": 0
}

Name	Description
phases_switched int	Phase switching state 1 - One phase connected 3 - Three phases connected
input3_state bool	State of input 3 true - Input closed false - Input open
input4_state bool	State of input 4 true - Input closed false - Input open
relay_state bool	State of the relay true - Relay closed false - Relay open
error_flags int	Active error states of the Energy Manager. This is a bitmask, so any combination of error values can occur. 0 - No error 0x00000002 - No network connection (LAN/WLAN) 0x00010000 - Contactor monitoring has triggered 0x01000000 - Internal error, Bricklet not reachable 0x02000000 - Internal error, SD card error 0x80000000 - Invalid configuration, details in config_error_flags
config_error_flags int	Active configuration errors of the Energy Manager. This is a bitmask, so any combination of configuration errors can occur. 0 - No error 0x00000001 - Phase switching or contactor not configured 0x00000002 - Maximum total current of chargers not configured 0x00000004 - No chargers configured 0x00000008 - Excess charging enabled but no electricity meter configured

energy_manager/low_level_state

Low-level state of the Energy Manager

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/energy_manager/low_level_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/low_level_state

{
  "consecutive_bricklet_errors": 0,
  "contactor": false,
  "contactor_check_state": 1,
  "input_voltage": 11925,
  "led_rgb": [0, 0, 0],
  "uptime": 940868435
}

Name	Description
consecutive_bricklet_errors int	Number of consecutive internal communication errors
contactor bool	Contactor state set by the Energy Manager true - Contactor closed false - Contactor open
contactor_check_state int	Contactor check state 0 - Contactor monitoring has triggered (contactor defective) 1 - No contactor error known (contactor OK)
input_voltage int (mV)	Internal supply voltage in millivolts.
led_rgb int[3]	Status LED color [0] - Red: 0 (off) to 255 (maximum intensity) [1] - Green: 0 (off) to 255 (maximum intensity) [2] - Blue: 0 (off) to 255 (maximum intensity)
uptime int (ms)	Time since starting the Energy Manager Bricklet. Attention: This time is measured directly via the processor clock. The accuracy is therefore only sufficient for time measurements in the range of minutes to a few hours. The time measurement overflows after approximately 50 days and starts again at 0.

energy_manager/sdcard_state

Information about the inserted MicroSD card.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/energy_manager/sdcard_state

MQTT (mosquitto)

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

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/energy_manager/sdcard_state

{
  "sd_status": 0,
  "lfs_status": 0,
  "card_type": 12,
  "sector_count": 15759360,
  "sector_size": 512,
  "manufacturer_id": 116,
  "product_rev": 32,
  "product_name": "USDU1"
}

Name	Description
sd_status int	SD card status 0 - OK 1 - READ_BLOCK_TIMEOUT 2 - WRITE_BLOCK_TIMEOUT 3 - RESPONSE_TIMEOUT 11 - ERROR_INIT_TYPE 12 - ERROR_INIT_VER_OR_VOLTAGE 13 - ERROR_INIT_ACMD41 14 - ERROR_INIT_CMD58 15 - ERROR_INIT_CMD0 21 - ERROR_CID_START 22 - ERROR_CID_CMD10 31 - ERROR_CSD_START 32 - ERROR_CSD_CMD9 41 - ERROR_COUNT_TO_HIGH 51 - ERROR_NO_CARD 255 - ERROR_API_FAILURE
lfs_status int	Status of the file system (LittleFS) on the SD card 0 - OK 255 - ERROR_API_FAILURE 256 - SD card is being formatted
card_type int	SD card type 0 - No SD card found 1 - MMC 2 - SD 4 - SDSC 12 - SDHC/SDXC
sector_count int	SD card size in sectors
sector_size int	Size of a sector
manufacturer_id int	Manufacturer ID
product_rev int	Product revision
product_name string	Product name

energy_manager/sdcard_format

Formats the inserted SD card and thus deletes the energy balance history. Cannot be undone! A restart is automatically performed afterwards.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/energy_manager/sdcard_format -d '{ "do_i_know_what_i_am_doing": false }'

MQTT (mosquitto)

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

Write

mosquitto_pub -h $BROKER -t $PREFIX/energy_manager/sdcard_format -m '{ "do_i_know_what_i_am_doing": false }'

Name	Description
do_i_know_what_i_am_doing bool	Indicates whether the SD card should be formatted true - Format SD card false - Perform no action