IDIAG Battery v1

Alerting connected solution for backup power supply.

Warning

This device type must be configured to be fully operational, see configuration endpoint.

Details:

  • device: IDIAG_Battery
  • version: 1
  • deviceType: IDIAG_Battery_v1

Message: Battery Depleted Notification

Occurrence: When the device detect that the battery reached discharge levels that could damage it.

Prerequisites:

  • The device must be correctly initialized (see: initialization)
  • The device configuration must be set

eventId: battery-depleted

Resources:

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Counter deepdischarges

Number of deep discharges.

Details:

  • name: counter_deepdischarges
  • category: counter
  • unit: unit.nounit
  • type: number
  • min value: 0

Message: Battery Low Alert

Occurrence: When the device detect that the battery will soon reach discharge levels that could damage it.

Repetition: Until the power is restored

  1. Every 20 minutes during 2 hours
  2. Every 6 hours during 12 hours (twice)
  3. See Keep Alive

Note

The message is repeated with the same battery_low_alert_id
Resources like battery_voltage are updated for each repetitions.
It allows you to have a finer resolution at critical moments.

Prerequisites:

  • The device must be correctly initialized (see: initialization)
  • The device configuration must be set

eventId: battery-low

Resources:

Alerts deepdischarge

Always True in this message.

True if the battery-low alert is currently running.
False if the battery-low alert is currently not running.

Details:

  • name: alerts_deepdischarge
  • category: alert
  • unit: unit.none
  • type: bool

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Battery low alert id

Deep discharge alert id, allows to discriminate repetitions.

Details:

  • name: battery_low_alert_id
  • category: id
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 15

Message: Configuration Acknowledgment

Occurrence: Each time a configuration is correctly received by the device

eventId: configuration-ack

Resources:

Incremented for each new configuration, allows to discriminate repetitions.

Details:

  • name: downlink_sequence
  • category: counter
  • unit: unit.nounit
  • type: number
  • min value: 0

0: Configuration correctly taken into account

Details:

  • name: downlink_errorcode
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 254
  • error value: 255

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Device rssi

Received Signal Strength Indication.

Details:

  • name: device_rssi
  • category: radio.rssi
  • unit: unit.dbm
  • type: number
  • min value: -254
  • max value: 0
  • error value: 255

Message: Disconnected Alert

Occurrence: When the device is disconnected from the monitored battery

Repetition: Until the power is restored

  1. Every 20 minutes during 2 hours
  2. Every 6 hours during 12 hours (twice)
  3. See Keep Alive

Note

The message is repeated with the same disconnected_alert_id.
Resources like time_disconnected are updated for each repetitions.
It allows you to have a finer resolution at critical moments.

eventId: battery-disconnected

Resources:

Alerts disconnected

Always True in this message.

True if the disconnected alert is currently running.
False if the disconnected alert is currently not running.

Details:

  • name: alerts_disconnected
  • category: alert
  • unit: unit.nounit
  • type: bool

Battery voltage

The monitored battery voltage. Should be 0v is this message.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Disconnected alert id

Disconnected alert id, allows to discriminate repetitions.

Details:

  • name: disconnected_alert_id
  • category: id
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 15

Time disconnected

Number of minutes since the disconnected alert started.

Details:

  • name: time_disconnected
  • category: duration
  • unit: unit.minute
  • type: number
  • min value: 0
  • max value: 1019
  • error value: 1023

Configuration battery type

The configured monitored battery type :

  • 0 : Default
  • 1 : Lead
  • 2 : Nimh/NiCd
  • 3 : Li-ion
  • 4 : LifePO4

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_battery_type
  • category: type
  • unit: unit.nounit
  • type: number
  • min value: 1
  • max value: 4
  • error value: 7

Configuration rated voltage

The configured nominal voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_rated_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7

Configuration minimal voltage

The configured service loss voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_minimal_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7

Configuration alerts batterydepleted

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the battery depleted alert is currently enabled.
False if the battery depleted alert is currently disabled.

Details:

  • name: configuration_alerts_batterydepleted
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts lowbatterycharge

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the battery low alert is currently enabled.
False if the battery low alert is currently disabled.

Details:

  • name: configuration_alerts_lowbatterycharge
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts batteryconnection

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the disconnected alert is currently enabled.
False if the disconnected alert is currently disabled.

Details:

  • name: configuration_alerts_batteryconnection
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts servicelossimminent

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 5% alert is currently enabled.
False if the service loss 5% alert is currently disabled.

Details:

  • name: configuration_alerts_servicelossimminent
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts serviceloss25

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 25% alert is currently enabled.
False if the service loss 25% alert is currently disabled.

Details:

  • name: configuration_alerts_serviceloss25
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts serviceloss50

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 50% alert is currently enabled.
False if the service loss 50% alert is currently disabled.

Details:

  • name: configuration_alerts_serviceloss50
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts powerloss

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the power-loss alert is currently enabled.
False if the power-loss alert is currently disabled.

Details:

  • name: configuration_alerts_powerloss
  • category: condition
  • unit: unit.nounit
  • type: bool

Message: Keep Alive

Occurrence: Every 6 hours

eventId: keep-alive

Resources:

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Alerts deepdischarge

True if the battery-low alert is currently running.
False if the battery-low alert is currently not running.

Details:

  • name: alerts_deepdischarge
  • category: alert
  • unit: unit.nounit
  • type: bool

Alerts serviceloss level

  • -1 : no service-loss alerts currently running
  • 0 : service-loss 50% currently running
  • 1 : service-loss 25% currently running
  • 2 : service-loss 5% currently running

Details:

  • name: alerts_serviceloss_level
  • category: alert
  • unit: unit.nounit
  • type: number

Alerts disconnected

True if the disconnected alert is currently running.
False if the disconnected alert is currently not running.

Details:

  • name: alerts_disconnected
  • category: alert
  • unit: unit.nounit
  • type: bool

Alerts powerloss

True if the power-loss alert is currently running.
False if the power-loss alert is currently not running.

Details:

  • name: alerts_powerloss
  • category: alert
  • unit: unit.nounit
  • type: bool

Time charge total

The total time the monitored battery was in charge.

Details:

  • name: time_charge_total
  • category: counter
  • unit: unit.hour
  • type: number
  • min value: 0

Time discharge total

The total time the monitored battery was in discharge.

Details:

  • name: time_discharge_total
  • category: counter
  • unit: unit.hour
  • type: number
  • min value: 0

Time disconnected total

The total time the monitored battery was disconnected.

Details:

  • name: time_disconnected_total
  • category: counter
  • unit: unit.hour
  • type: number
  • min value: 0

Counter chargecycles

Number of charge cycles.

Details:

  • name: counter_chargecycles
  • category: counter
  • unit: unit.nounit
  • type: number
  • min value: 0

Counter deepdischarges

Number of deep discharges.

Details:

  • name: counter_deepdischarges
  • category: counter
  • unit: unit.nounit
  • type: number
  • min value: 0

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Message: Power Loss Alert

Occurrence: When the device detect power is drawn from the monitored battery

Repetition: Until the power is restored

  1. Every 20 minutes during 2 hours
  2. Every 6 hours during 12 hours (twice)
  3. See Keep Alive

Note

The message is repeated with the same powerloss_alert_id.
Resources like battery_voltage and time_discharge are updated for each repetitions.
It allows you to have a finer resolution at critical moments.

Prerequisites:

  • The device must be correctly initialized (see: initialization)
  • The device configuration must be set

eventId: power-loss

Resources:

Alerts powerloss

Always True in this message.

True if the power-loss alert is currently running.
False if the power-loss alert is currently not running.

Details:

  • name: alerts_powerloss
  • category: alert
  • unit: unit.nounit
  • type: bool

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Powerloss alert id

Power loss alert id, allows to discriminate repetitions.

Details:

  • name: powerloss_alert_id
  • category: id
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 15

Time discharge

Number of minutes since the power-loss alert started.

Details:

  • name: time_discharge
  • category: duration
  • unit: unit.minute
  • type: number
  • min value: 0
  • max value: 1020
  • error value: 1023

Configuration battery type

The configured monitored battery type :

  • 0 : Default
  • 1 : Lead
  • 2 : Nimh/NiCd
  • 3 : Li-ion
  • 4 : LifePO4

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_battery_type
  • category: type
  • unit: unit.nounit
  • type: number
  • min value: 1
  • max value: 4
  • error value: 7

Configuration rated voltage

The configured nominal voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_rated_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7

Configuration minimal voltage

The configured service loss voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_minimal_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7

Configuration alerts batterydepleted

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the battery depleted alert is currently enabled.
False if the battery depleted alert is currently disabled.

Details:

  • name: configuration_alerts_batterydepleted
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts lowbatterycharge

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the battery low alert is currently enabled.
False if the battery low alert is currently disabled.

Details:

  • name: configuration_alerts_lowbatterycharge
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts batteryconnection

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the disconnected alert is currently enabled.
False if the disconnected alert is currently disabled.

Details:

  • name: configuration_alerts_batteryconnection
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts servicelossimminent

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 5% alert is currently enabled.
False if the service loss 5% alert is currently disabled.

Details:

  • name: configuration_alerts_servicelossimminent
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts serviceloss25

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 25% alert is currently enabled.
False if the service loss 25% alert is currently disabled.

Details:

  • name: configuration_alerts_serviceloss25
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts serviceloss50

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the service loss 50% alert is currently enabled.
False if the service loss 50% alert is currently disabled.

Details:

  • name: configuration_alerts_serviceloss50
  • category: condition
  • unit: unit.nounit
  • type: bool

Configuration alerts powerloss

Alerts detection can be enabled/disabled via configuration (see, configuration endpoint)

True if the power-loss alert is currently enabled.
False if the power-loss alert is currently disabled.

Details:

  • name: configuration_alerts_powerloss
  • category: condition
  • unit: unit.nounit
  • type: bool

Message: Power Restored

Occurrence: When the device detect power stopped being dawn from the monitored battery

Repetition:

  1. Every 20 minutes during 2 hours
  2. Every 6 hours during 12 hours (twice)

Note

The message is repeated with the same end_alert_id.
Resources like battery_voltage are updated for each repetitions.
It allows you to have a finer resolution at critical moments.

Prerequisites:

  • The device must be correctly initialized (see: initialization)
  • The device configuration must be set

eventId: power-restored

Resources:

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

End alert id

End of alert id, allows to discriminate repetitions.

Details:

  • name: end_alert_id
  • category: id
  • unit: unit.nounit
  • type: number

Alerts deepdischarge

Always False in this message.

True if the battery-low alert is currently running.
False if the battery-low alert is currently not running.

Details:

  • name: alerts_deepdischarge
  • category: alert
  • unit: unit.none
  • type: bool

Alerts serviceloss level

Always -1 in this message.

  • -1 : no service-loss alerts currently running
  • 0 : service-loss 50% currently running
  • 1 : service-loss 25% currently running
  • 2 : service-loss 5% currently running

Details:

  • name: alerts_serviceloss_level
  • category: alert
  • unit: unit.nounit
  • type: number

Alerts disconnected

Always False in this message.

True if the disconnected alert is currently running.
False if the disconnected alert is currently not running.

Details:

  • name: alerts_disconnected
  • category: alert
  • unit: unit.nounit
  • type: bool

Alerts powerloss

Always False in this message.

True if the power-loss alert is currently running.
False if the power-loss alert is currently not running.

Details:

  • name: alerts_powerloss
  • category: alert
  • unit: unit.nounit
  • type: bool

Message: Service Loss Alert

Occurrence: When the device detect power is drawn from the monitored battery and it may cause a service breakdown.

There is three service loss level (see alerts_serviceloss_level resource).

Repetition: Until the power is restored

  1. Every 20 minutes during 2 hours
  2. Every 6 hours during 12 hours (twice)
  3. See Keep Alive

Note

The message is repeated with the same serviceloss_alert_id unless the alerts_serviceloss_level changes.
Resources like battery_voltage are updated for each repetitions.
It allows you to have a finer resolution at critical moments.

Prerequisites:

  • The device must be correctly initialized (see: initialization)
  • The device configuration must be set

eventId: service-loss

Resources:

Battery voltage

The monitored battery voltage.

Details:

  • name: battery_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 136
  • error value: 163.83

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Serviceloss alert id

Service loss alert id, allows to discriminate repetitions.

Details:

  • name: serviceloss_alert_id
  • category: id
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 15

Alerts serviceloss level

  • 0 : service-loss 50%
  • 1 : service-loss 25%
  • 2 : service-loss 5%

Details:

  • name: alerts_serviceloss_level
  • category: alert
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 2
  • error value: 7

Message: Starting

Occurrence: When the device starts

eventId: device-init

Resources:

Device health

Device power supply state :

  • 0 : Full
  • 1 : High
  • 2 : Medium
  • 3 : Low

Details:

  • name: device_health
  • category: state
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 3

Configuration battery type

The configured monitored battery type :

  • 0 : Default
  • 1 : Lead
  • 2 : Nimh/NiCd
  • 3 : Li-ion
  • 4 : LifePO4

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_battery_type
  • category: type
  • unit: unit.nounit
  • type: number
  • min value: 0
  • max value: 4
  • error value: 7

Configuration rated voltage

The configured nominal voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_rated_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7

Configuration minimal voltage

The configured service loss voltage.

See the configuration endpoint for more information on configuration.

Details:

  • name: configuration_minimal_voltage
  • category: voltage
  • unit: unit.volt
  • type: number
  • min value: 0
  • max value: 110
  • error value: 204.7