HM (Health Metrics)

This command applies to the XBee 3 Cellular LTE-M/NB-IoT.

Sets the Health Metrics to report. This is a bit-mask of values. Each bit set in the mask represents a metric which is reported to Remote Manager.

Parameter range

N/A

Bit Description

0

Signal Strength.

Set bit 0 to enable reporting of signal strength metrics.

If available on your device the following metrics are reported:

  • "metrics/signal_strength": Uncached RSSI signal value. This is the same value as reported by the DB command with parameter 1, in dbM.
  • "metrics/signal_receive_power": Reference Signals Received Power (RSRP). This is the same value as reported by the SW command, in dBm.
  • "metrics/signal_receive_quality": Reference Signal Received Quality (RSRQ). This is the same value as reported by the SQ command, in dB.
1

Module Temperature in Celsius. This is reported to the "metrics/temperature" Data Stream in Remote Manager for the devices.

2

TCP data estimated transfer counters.

Set bit 2 to enable reporting of data counters for TCP traffic.

The data reported is application data and does not include the overhead of the protocol. Data not counted includes headers and retransmissions which may be used by providers to calculate billed amounts.

The metrics are set to 0 after reset or after the metrics are reported to Remote Manager.

The reported metrics are as follows:

  • "metrics/tcp/sent": TCP data sent from the device.
  • "metrics/tcp/received": TCP data received.
3

UDP data estimated transfer counters.

Set bit 3 to enable reporting of data counters for UDP traffic.

The data reported is application data and does not include the overhead of the UDP protocol including headers.

The metrics are set to 0 after reset or after the metrics are reported to Remote Manager.

The reported metrics are as follows:

  • "metrics/udp/sent": UDP data sent from the device.
  • "metrics/udp/received": UDP data received.
4

Link Deactivations.

Set bit 4 to enable reporting the number of internet link deactivations since the last reset or reporting.

The metrics are set to 0 after reset or after the metrics are reported to Remote Manager.

This is reported to the "metrics/link_deactivations" Data Stream in Remote Manager for the devices.

5

Sleep metrics counter.

Set bit 5 to enable reporting of the number of times the device has slept since the last report.

This works in conjunction with the HF command.

The value is reset to 0 after reset or after the metrics are reported to Remote Manager.

7

Enable reporting of information about the current serving cell.

The reported metrics include:

  • Mobile Country Code: metrics/cellular/1/sim1/mcc

  • Mobile Network Code: metrics/cellular/1/sim1/mnc

  • Location Area Code: metrics/cellular/1/sim1/lac

  • Cell ID: metrics/cellular/1/sim1/cid

Default

0x0