Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type [Size]

Description

Alarm States

uint8_t[6]

Each byte represents the alarm state of an areas so state[4] is the fifth alarms sate a value of 1 means alarm in area, 0 means no alarmĀ 

Navigation Area Rules get/set

This message configures the SafeGuard Lite feature with up to six areas that can cause an alarm state if a target is detected above the area threshold inside the area.

The Navigation Area Rules Get/Set message allows the client to request the current Navigation Area Rules from the Radar, and provide an update to supersede the current configuration. This is only supported by NavOS radars running firmware version 3.1.0.169 or later.

A Navigation Rules Request message is an empty payload message sent to the Radar, to which the Radar responds by sending a Navigation Rules message. The client may sent an update of the Navigation Area Rules parameters by sending a Set Navigation Area Rules message.

Navigation Area Rules message structure

A Navigation Area Rules message is a variable length message, consisting of one or more Navigation Area Rule structures.

...

Field

Type [Size]

Description

Rule count

uint8_t [1]

The number of rules in the message; should not be zero

A Navigation Area Rule consists of a fixed header, plus a variable number of Points, which define the area over which the rule is applied.

...

Field

Type [Size]

Description

Rule Length

uint32_t [4]

The complete size of the Rule in bytes. This value is calculated as sizeof (rule header) + (point count * sizeof(Point))

ID

uint8_t [1]

Integer identifier

Enabled

bool [1]

uint8_t interpreted as an implied Boolean: 0 - false; 1 - true

Invert break logic

bool [1]

uint8_t interpreted as an implied Boolean: 0 - false; 1 - true

Threshold delta

float [2]

Floating point value, stored as a signed 2-byte integer to one (implied) decimal place. That is, the stored value is held as (actual value * 10.0)

Break allowance

uint16_t [2]

Break allowance as 16-bit unsigned value

Allowance curve decrement

uint16_t [2]

Allowance curve decrement as 16-bit unsigned value

Point count

uint16_t [2]

The number of Point objects that follow for this Rule

Points

Point [point count * sizeof(Point)]

A variable number of Point structures, stored contiguously

A Point is a fixed-size structure, holding coordinates. A Navigation Area Rule will contain a variable number of points, defining an area.

...

Field

Type [Size]

Description

x

float [2]

Floating point value, stored as a signed 2-byte integer to one (implied) decimal place. That is, the stored value is held as (actual value * 10.0)

y

float [2]

Floating point value, stored as a signed 2-byte integer to one (implied) decimal place. That is, the stored value is held as (actual value * 10.0)

C# Example of how to encode rules

...