add AAR settings [DIP-59] (#560)

* add AAR settings [DIP-59]

* cast

* more casting

Author: Jason Mobarak

python/libsettings.pyx

@@ -135,18 +135,18 @@ cdef class Settings:
 
     def __init__(self, link, sender_id=SENDER_ID, debug=False):
         self.c_api.ctx = <void *>self
-        self.c_api.send = &send_wrapper
-        self.c_api.send_from = &send_from_wrapper
-        self.c_api.wait_init = &wait_init_wrapper
-        self.c_api.wait = &wait_wrapper
-        self.c_api.signal = &signal_wrapper
-        self.c_api.wait_thd = &wait_thd_wrapper
-        self.c_api.signal_thd = &signal_thd_wrapper
-        self.c_api.lock = &lock_wrapper
-        self.c_api.unlock = &unlock_wrapper
-        self.c_api.register_cb = &register_cb_wrapper
-        self.c_api.unregister_cb = &unregister_cb_wrapper
-        self.c_api.log_preformatted = log_wrapper
+        self.c_api.send = <settings_send_t>&send_wrapper
+        self.c_api.send_from = <settings_send_from_t>&send_from_wrapper
+        self.c_api.wait_init = <settings_wait_init_t>&wait_init_wrapper
+        self.c_api.wait = <settings_wait_t>&wait_wrapper
+        self.c_api.signal = <settings_signal_t>&signal_wrapper
+        self.c_api.wait_thd = <settings_wait_thd_t>&wait_thd_wrapper
+        self.c_api.signal_thd = <settings_signal_thd_t>&signal_thd_wrapper
+        self.c_api.lock = <settings_lock_t>&lock_wrapper
+        self.c_api.unlock = <settings_unlock_t>&unlock_wrapper
+        self.c_api.register_cb = <settings_reg_cb_t>&register_cb_wrapper
+        self.c_api.unregister_cb = <settings_unreg_cb_t>&unregister_cb_wrapper
+        self.c_api.log_preformatted = <settings_log_preformatted_t>log_wrapper
 
         self.ctx = settings_create(sender_id, &self.c_api)
 

settings.yaml

@@ -1,5 +1,182 @@
 ---
 
+- group: aar
+  name: pnm_id
+  expert: false
+  type: integer
+  units: N/A
+  default value: '0'
+  readonly: false
+  Description: PNM Identification. Range [0..2]. 0 = Non-locomotive, startup, advanced configuration; 1 = PNM1; 2 = PNM2
+  Notes:
+
+- group: aar
+  name: pcps_pos_reference
+  expert: false
+  type: string
+  units: N/A
+  default value: '1'
+  readonly: false
+  Description: Reported locomotive position reference. Range [1..4]. 1 = Antenna ARP; 2 = Antenna Centroid; 3 = Front Coupler; 4 = Rear Coupler
+  Notes: Valid locomotive attitude is required to compute Antenna Centroid, Front Coupler and Rear Coupler positions. Attitude may not be available after receiver start before the locomotive movement in a good sky visibility conditions.
+
+- group: aar
+  name: pcsh_ss_ssd_thr_high_precision_mph
+  expert: true
+  type: float
+  units: MPH
+  default_value: 0.2
+  Description: Speed SD threshold below which speed High Precision mode is reported. Range [0.0..1000.0].
+  Notes:
+
+- group: aar
+  name: pcsh_ss_ssd_thr_standard_mph
+  expert: true
+  type: float
+  units: MPH
+  default_value: 1.0
+  Description: Speed SD threshold below which speed Standard mode is reported. Range [0.0..1000.0].
+  Notes:
+
+- group: aar
+  name: pcsh_ss_ssd_thr_degraded_mph
+  expert: true
+  type: float
+  units: MPH
+  default_value: 2.5
+  Description: Speed SD threshold below which speed Degraded mode is reported. Range [0.0..1000.0].
+  Notes: Speed Very Low Confidence mode is reported when the speed is valid and speed SD is above this threshold.
+
+- group: aar
+  name: pcsh_ss_hsd_thr_high_precision_deg
+  expert: true
+  type: float
+  units: degrees
+  default_value: 0.5
+  Description: Heading SD threshold below which heading High Precision mode is reported. Range [0.0..180.0].
+  Notes:
+
+- group: aar
+  name: pcsh_ss_hsd_thr_standard_deg
+  expert: true
+  type: float
+  units: degrees
+  default_value: 2.0
+  Description: Heading SD threshold below which heading Standard mode is reported. Range [0.0..180.0].
+  Notes:
+
+- group: aar
+  name: pcsh_ss_hsd_thr_degraded_deg
+  expert: true
+  type: float
+  units: degrees
+  default_value: 5.0
+  Description: Heading SD threshold below which heading Degraded mode is reported. Range [0.0..180.0].
+  Notes: Heading Very Low Confidence mode is reported when the heading is valid and heading SD is above this threshold.
+
+- group: aar
+  name: pcof_along_track_offset_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna ARP Along Track Offset. Range [0.0..655.35].
+  Notes: Distance is measured from the pulling face of the front coupler towards the rear of the locomotive.
+
+- group: aar
+  name: pcof_cross_track_offset_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna ARP Cross Track Offset. Range [-327.68..327.67].
+  Notes: Distance is measured from the locomotive centerline towards the right of the locomotive.
+
+- group: aar
+  name: pcof_vertical_offset_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna ARP Vertical Offset. Range [0.0..655.35].
+  Notes: Distance is measured from the top of the rail up.
+
+- group: aar
+  name: pcof_along_track_offset_ac_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna Centroid Along Track Offset. Range [0.0..655.35].
+  Notes: Distance is measured from the pulling face of the front coupler towards the rear of the locomotive.
+
+- group: aar
+  name: pcof_cross_track_offset_ac_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna Centroid Cross Track Offset. Range [-327.68..327.67].
+  Notes: Distance is measured from the locomotive centerline towards the right of the locomotive.
+
+- group: aar
+  name: pcof_vertical_offset_ac_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Antenna Centroid Vertical Offset. Range [0.0..655.35].
+  Notes: Distance is measured from the top of the rail up.
+
+- group: aar
+  name: pcof_loco_length_m
+  expert: false
+  type: float
+  units: m
+  default_value: 0.0
+  Description: Locomotive length. Range [0.0..655.35].
+  Notes: Distance is measured from the pulling face of the front coupler to the pulling face of the rear coupler.
+
+- group: aar
+  name: pccf_mfg_id
+  expert: true
+  type: integer
+  units: N/A
+  default value: '0'
+  readonly: false
+  Description: Manufacturer ID. Range [0..255].
+  Notes:
+
+- group: aar
+  name: pccf_device_reported
+  expert: true
+  type: integer
+  units: N/A
+  default value: '0'
+  readonly: false
+  Description: Device being reported. Range [0..65535].
+  Notes:
+
+- group: aar
+  name: pccf_equipment_description
+  expert: true
+  type: string
+  units: N/A
+  default value: ''
+  readonly: false
+  Description: Equipment description. Maximum 255 characters.
+  Notes:
+
+- group: aar
+  name: pcsd_imu_stat_period_s
+  expert: true
+  type: integer
+  units: N/A
+  default value: '1'
+  readonly: false
+  Description: IMU statistic computation period. Range [0..1000].
+  Notes: When set to zero statistic will be computed at the position output rate.
+
 - group: acquisition
   name: sbas_acquisition_enabled
   expert: false
@@ -557,7 +734,7 @@
   default value: '20'
   readonly: false
   Description: Indicates the maximum standard deviation of position for which the inertial system will dead reckon.
-  Notes: The default value of 20 meters was chosen as the logical minimum standard of the position accuracy during dead reckon mode. 
+  Notes: The default value of 20 meters was chosen as the logical minimum standard of the position accuracy during dead reckon mode.
 
 - group: ins
   name: build_name
@@ -1837,11 +2014,11 @@
   Description: |
     The frequency at which GNSS navigation solution is computed.
   Notes: |
-    Minimum is 1 Hz. Maximum is 10 Hz for RTK positioning with a maximum of 15 used satellites. 
-    At 5 Hz and lower the maximum number of used satellites is 22. 20 Hz is an absolute maximum with 
+    Minimum is 1 Hz. Maximum is 10 Hz for RTK positioning with a maximum of 15 used satellites.
+    At 5 Hz and lower the maximum number of used satellites is 22. 20 Hz is an absolute maximum with
     a limit of 5 used satellites.
 
-    System with inertial fusion (Duro Inertial, Piksi Multi Inertial) can output position at a higher rate 
+    System with inertial fusion (Duro Inertial, Piksi Multi Inertial) can output position at a higher rate
     than the GNSS-only solution. See fused_soln_freq in the INS group.
 
 - group: solution
@@ -2891,6 +3068,16 @@
   Notes: The address setting is defined according to the convention "hostname:port".
     For example, it should match the format 192.168.0.222:55555 or xxxxx.net:2101 .
 
+- group: udp_client0
+  name: multicast_ttl
+  expert: true
+  type: integer
+  units: N/A
+  default value: '1'
+  readonly: false
+  Description: Multicast Time To Live property. Range [1..255].
+  Notes:
+
 - group: udp_client1
   name: mode
   expert: false
@@ -2936,6 +3123,16 @@
   Notes: The address setting is defined according to the convention "hostname:port".
     For example, it should match the format 192.168.0.222:55555 or xxxxx.net:2101 .
 
+- group: udp_client1
+  name: multicast_ttl
+  expert: true
+  type: integer
+  units: N/A
+  default value: '1'
+  readonly: false
+  Description: Multicast Time To Live property. Range [1..255].
+  Notes:
+
 - group: udp_server0
   name: mode
   expert: false