...
The health message includes critical health information about the radar. The payload consists of a number of health status structures, each one provides data on a specific metric, for example temperature, and includes details on the current measurement and whether the metric is within expected bounds or not. The health message payload is a Protocol Buffer serialised byte array. In order to de-serialise the message the client will need to use the Google library as described in reference [2]. Metrics may be added or changed within the content of the Protocol Buffer message. This would not result in a new protocol version for this message. Client applications consuming this message will need the latest Protobuf definition file from Navtech. These are available on request. Health messages need to be switched on before they are transmitted. Once active, health messages will be sent every 5 seconds. Messages will continue to be sent until the radar receives a message to stop. Clients should honour this mechanism and, where possible, send the radar a stop message before disconnecting.
...
Health message Protocol Buffer structure
Field | Type [Size] | Description | Temperature|||
|---|---|---|---|---|---|
Die temperature | HealthInfo PB Message | Die temperature | |||
SOC temperature | HealthInfo PB Message | System On Chip temperature | |||
VCO temperature | HealthInfo PB Message | Voltage Controlled Oscillator temperature | |||
Ambient temperature | HealthInfo PB Message | Temperature health information including current operating Radar-measured ambient temperature | |||
Rotation | HealthInfo PB Message | Rotation health information including current Current speed | |||
Packet Rate | HealthInfo PB Message | Network health information including current Current packet rate | |||
RF Health Check | HealthInfo PB Message | RF health information including current noise deviation from the norm | Motor Current | HealthInfo PB Message | Motor health information including current draw |
Transmitting | bool | Transmitter enabled | |||
Expected rotation | uint32 | Expected radar rotation speed in mHz | |||
Expected packet rate | uint32 | Expected data output rate in packets/sec | |||
MAC address | string | Radar MAC address | |||
Encoder error count | int32 | Errors recorded from the radar rotary position encoder | |||
System uptime | float | Seconds since last reboot | |||
Motor Current | HealthInfo PB Message | Motor current draw | |||
Software uptime | uint64 | Seconds the firmware has been running | |||
Total uptime | uint64 | Cumulative time the system has been operating for | |||
Network state | NetworkInfo PB mesage | Network information | |||
Client limit | int32 | The maximum number of clients allowed | |||
IP clients | string | IP addresses of any currently-connected clients | |||
Expected RX packet rate | uint32 | Expected receive packet rate, based on current configuration, in packets/sec | |||
Uplink errors | uint32 | Internal link uplink error count | |||
Downlink errors | uint32 | Internal link downlink error count | |||
Uplink missed | uint32 | Internal link uplinks missed error count | |||
Downlink missed | uint32 | Internal link downlinks missed error count | |||
Running uptime | uint64 | Number of seconds the radar has been rotating |
HealthInfo Protocol Buffer structure
Field | Type [Size] | Description |
|---|---|---|
Minimum value | float | Lower bound |
Maximum value | float | Upper bound |
Value | float | Current value |
Status | Enumeration | Current health status - HEALTHY, WARNING, UNHEALTHY, UNKNOWN |
Warning allowance | int32 | The number of out-of-bounds samples before the health status transitions from HEALTHY to WARNING |
Unhealthy allowance | int32 | The number of out-of-bounds samples before the health status transitions from WARNING to UNHEALTHY |
Clear allowance | int32 | The number of in-bound samples before the health status returns to HEALTHY |
NetworkInfo structure
Field | Type [Size] | Description |
|---|---|---|
Network state | Enumeration | Current network state - UP, DOWN or UNKNOWN |
Duplex | Enumeration | Network duplex - HALF or FULL |
Speed | uint32 | Network speed |
Contour Update Message
The Contour Update message controls the contour mode and contour map. The contour map is held on the radar and provides a mechanism to restrict the radar detection area. The map consists of a variable range per degree (i.e. 360). When a contour map is active, data is sent out from the radar for each degree up to the range specified. If the range is zero then no data is sent for that bearing. If the contour map is disabled or in its default configuration then the full range of data is sent for every azimuth (i.e. all data). There is also a test mode which can be set on the radar – this activates a pre-configured map which exhibits a distinctive data pattern. To disable the contour map the client should send an empty update message (just header). This will leave the contour configuration intact but tell the radar to stop using it. Alternatively the client can send a full contour map, in other words a maximum range value for each azimuth. This will have the same effect. The contour map, once active, restricts the amount of data sent over the network. The more restrictive the contour map, the less data that is sent.
...