props.h

Open DMT Client C Source code

#define PROP_GPS_DISTANCE_DELTA         0xF531
    // Description:
    //      Distance delta
    // Value: 
    //      0:4 - [UInt32] The minimum distance that the device has to move (in 1 meter
    //            units) for distance (ie. odometer) accumulation
    //            Valid range: 1 to 4294967295 meters (however, the client may impose 
    //            a minimum)
    // Special data length rules:
    //      - The effect of a 0-length value is defined by the client.
    // Notes:
    //      - The device must move this number of meters before a distance accumulation
    //      (ie. odometer) is performed.  (The new GPS fix may then be stored in
    //      PROP_ODOMETER_#_GPS or PROP_ODOMETER_#_STATE)
    //      - This value should be larger than the accuracy capability of the GPS module.
    //      Setting this value too low (eg. 20 meters) may cause the device to accumulate
    //      distance even though the device isn't moving.  The value should not be less 
    //      than the value specified for PROP_GPS_ACCURACY.  For non-WAAS enabled GPS
    //      modules, this value probably should not be less that 500 meters.  For WAAS
    //      enabled modules, this value could probably be around 200 meters.  Experiment
    //      with this and check the results for yourself.
    //      - This value effects all accumulated odometer values.

// ----------------------------------------------------------------------------
// GeoZone properties:

#define PROP_CMD_GEOF_ADMIN             0xF542
    // Description: [optional]
    //      Command[WO]: GeoZone admin
    // Set Value:
    //      0:1 - Admin command type
    //            0x10 Add GeoZone list to table (low resolution GPS fix points)
    //            0x11 Add GeoZone list to table (high resolution GPS fix points)
    //            0x20 Remove specified GeoZone(terminal) ID from table
    //            0x30 Save GeoZone table to predefined location.
    //   0x10: Add GeoZone list to table
    //      1:2 - Zone-ID (2 byte value)
    //      3:2 - bits 0:3  type
    //            bits 3:13 radius (meters)
    //      5:6 - Encoded Latitude/Longitude #1
    //     11:6 - Encoded Latitude/Longitude #2
    //     The above template may be repeated up to 15 times per packet.
    //   0x11: Add GeoZone list to table
    //      1:4 - Zone-ID (4 byte value)
    //      5:2 - bits 0:3  type
    //            bits 3:13 radius (meters)
    //      7:8 - Encoded Latitude/Longitude #1
    //     15:8 - Encoded Latitude/Longitude #2
    //     The above template may be repeated up to 11 times per packet.
    //   0x20: Remove specified GeoZone(terminal) ID from table
    //      1:2 - Zone-ID
    //     If 0xFFFF is specified for the Zone-ID, then all points will be removed
    //   0x30: Save GeoZone table to predefined location.
    //      1:X - Remaining payload will be ignored
    // Notes:
    //      - The method used for storing GeoZones/Geofences may necessarily
    //      be very dependent on the client device on which OpenDMTP resides.
    //      The above represents a standard extension for those client devices
    //      that are able to support this type of GeoZone/Geofence format.  If
    //      the client device is unable to support this format and wishes to 
    //      implement its own custom method for GeoZone/Geofence detection, then
    //      it should always respond with the COMMAND_FEATURE_NOT_SUPPORTED if 
    //      this command property is called.

#define PROP_GEOF_COUNT                 0xF547
    // Description: [optional]
    //      [Read-Only] Geozone table entry count
    // Get Value: 
    //      0:2 - Number Geozone entries in table

#define PROP_GEOF_VERSION               0xF548
    // Description: [optional]
    //      Geozone table version
    // Get/Set Value: 
    //      0:X - [ASCIIZ] string representing server defined geofence version
    // Special data length rules:
    //      - The maximum length of the version string is 20 characters.

#define PROP_GEOF_ARRIVE_DELAY          0xF54A
    // Description: [optional]
    //      GeoZone arrival delay in seconds
    // Value: 
    //      0:2 - [UInt16] Number of seconds that the device must be in a GeoZone
    //            before is is considered "arrived".
    // Notes:
    //      - This property prevents devices being marked as 'arrived' when they
    //      are only "passing through".

#define PROP_GEOF_DEPART_DELAY          0xF54D
    // Description: [optional]
    //      GeoZone departure delay in seconds
    // Value:
    //      0:2 - [UInt16] Number of seconds that the device must be outside a GeoZone
    //            before it is considered "departed".
    // Notes:
    //      - The value for this property is generally small and prevents devices being 
    //      marked as 'departed' when they only left briefly.  This is generally only
    //      necessary to prevent oddball bouncing GPS locations from causing multiple
    //      improper arrival/departure messages.

#define PROP_GEOF_CURRENT               0xF551
    // Description: [optional]
    //      GeoZone ID in which the device is sitting
    // Value: 
    //      0:4 - [UInt32] GeoZone ID
    //            Valid range: 0x00000000 to 0x0000FFFF (0 means not in a GeoZone).
    // Notes:
    //      - This value may return a 32-bit value, however only the lower 16 bits
    //      are currently used.
    //      - This value should generally be set by the device itself at it enters or
    //      leave pre-defined geofenced areas.

// ----------------------------------------------------------------------------
// GeoCorridor properties:

#define PROP_CMD_GEOC_ADMIN             0xF562 // reserved for future use
    // Description: [optional]
    //      Command[WO]: GeoCorridor admin
#define PROP_GEOC_ACTIVE_ID             0xF567
    // Description: [optional]
    //      The active GeoCorridor ID
    // Value: 
    //      0:4 - [UInt32] Active GeoCorr ID
    //            Valid range: 0x00000000 to 0xFFFFFFFF (0 means no GeoCorr is active).
    // Note:
    //      - This is typically used for identifying an active alarm state geofence.
    //      - This value may be set by the device itself as it determines necesary
    //      as it enters or leaves predefined geofenced areas.

#define PROP_GEOC_VIOLATION_INTRVL      0xF56A
    // Description: [optional]
    //      During a sustained geofence violation, the number of seconds between GeoCorr
    //      violation events.
    // Value: 
    //      0:2 - [UInt16] Number of seconds between geofence violation events.  
    //            Valid range: 30 to 65535 seconds.
    // Notes:
    //      - This value represents the interval (in seconds) between GeoCorr violation
    //      events during a sustained geofence violation.

#define PROP_GEOC_VIOLATION_COUNT       0xF56D
    // Description:
    //      Maximum number of GeoCorridor violation messages to send
    // Value: 
    //      0:2 - [UInt16] Maximum number of violation messages to send during a GeoCorr
    //            violation.
    //            Valid range: 1 to 65535 events (0 indefinite)
    // Special data length rules:
    //      - A 0-length value indicates that the violation message count is indefinite.
    // Notes:
    //      - This value represents the number of GeoCorr violation events that should
    //        be sent once the device has determined that a GeoCorr violation has occurred.

// ----------------------------------------------------------------------------
// Motion properties:

#define PROP_MOTION_START_TYPE          0xF711
    // Description:
    //      Motion start type
    // Value: 
    //      0:1 - [UInt8] Motion start type
    //            Valid values: 0=kph, 1=meters moved, 2 to 255 are reserved.
    // Special data length rules:
    //      - A 0-length value implies a motion start type of '0' (KPH).
    // Notes:
    //      - This property defines the meaning of the value for the property 
    //        PROP_MOTION_START.  If this value is '0', then motion-start is defined
    //        if KPH.  If this value is '1', then motion-start is defined in the
    //        number of meters moved.

#define PROP_MOTION_START               0xF712
    // Description:
    //      Motion start definition
    // Value: 
    //      0:2 - [UInt16] Definition of start of motion in 0.1 KPH/Meters units
    //            Valid range: 0.1 to 6553.5 kph/meters (0.0 means this feature is inactive)
    // Special data length rules:
    //      - The 0-length value implies that motion start has not yet been defined.
    // Notes:
    //      - A value of 0 means that stop/stop motion events are not currently enabled.
    //      - Whether this value is interpreted as KPH or Meters depends on the value
    //        of the property PROP_MOTION_START_TYPE.

#define PROP_MOTION_IN_MOTION           0xF713
    // Description:
    //      In-motion interval
    // Value: 
    //      0:2 - [UInt16] Number of seconds between in-motion events
    //            Valid range: 0 to 65535 seconds (0 means this feature is inactive)
    // Special data length rules:
    //      - A 0-length value implies that the in-motion interval is not defined.
    // Notes:
    //      - A value of 0 means that no in-motion events are to be generated.
    //      - The minimum value specified for this property may be controlled by the 
    //        implementation of the transport in use.  For the OpenDMTP reference
    //        implementation, see the compile-time constant MIN_IN_MOTION_INTERVAL in
    //        the source file "src/modules/motion.c" for the minimum allowable value.

#define PROP_MOTION_STOP                0xF714
    // Description:
    //      Motion stop definition
    // Value: 
    //      0:2 - [UInt16] Definition of end of motion in number of seconds (1 to 65535 sec)
    // Special data length rules:
    //      none

#define PROP_MOTION_STOP_TYPE           0xF715
    // Description:
    //      Motion stop type
    // Value: 
    //      0:1 - [UInt8] Motion start type
    //            Valid values: 0=after_delay, 1=when_stopped, 2 to 255 are reserved.
    // Special data length rules:
    //      - A 0-length value implies a motion start type of '0' (after_delay).
    // Notes:
    //      - This property defines the effect of the value for the property 
    //        PROP_MOTION_STOP.  If this value is '0', then the stop-motion event will be
    //        generated with a timestamp at the time the PROP_MOTION_STOP timer has expired.
    //        Also in-motion messages will be generated on a scheduled interval until the
    //        stop-motion event is generated.  If this value is '1', then the timestamp of
    //        the generated stop-motion event will be the time that the vehicle actually
    //        stopped (the stop-motion event is delayed until the stopped timer is expired).
    //        Also, in-motion events will only be generated if the vehicle is actually in
    //        motion at the time the in-motion event is to be generated.

#define PROP_MOTION_DORMANT_INTRVL      0xF716
    // Description:
    //      'Dormant' interval
    // Value: 
    //      0:4 - [UInt32] Number of seconds between dormant events (1 to 4294967295 sec)
    //            Valid range: 0 to 4294967296 seconds (0 means no dormant messages)
    // Special data length rules:
    //      - A 0-length value indicates that dormant events are disabled.
    // Notes:
    //      - This value represents the interval (in seconds) between dormant events
    //        once the device has determined that it is no longer moving.  The number of
    //        dormant messages sent is defined by the property PROP_MOTION_DORMANT_COUNT.
    //      - The minimum value specified for this property may be controlled by the 
    //        implementation of the transport in use.  For the OpenDMTP reference
    //        implementation, see the compile-time constant MIN_DORMANT_INTERVAL in
    //        the source file "src/modules/motion.c" for the minimum allowable value.

#define PROP_MOTION_DORMANT_COUNT       0xF717
    // Description:
    //      Maximum number of dormant messages to send
    // Value: 
    //      0:2 - [UInt16] Maximum number of dormant messages to send during dormancy
    //            Valid range: 0 to 65535 events (0 indefinite)
    // Special data length rules:
    //      - A 0-length value indicates that the dormant message count is indefinite.
    // Notes:
    //      - This value represents the number of dormant messages that should be
    //        sent once the device has determined that it is no longer moving.
    //        Typically, this value is 0 (indefinite), however it may be desirable to
    //        have a limited number of dormant messages sent by the client.

#define PROP_MOTION_EXCESS_SPEED        0xF721  // Excess speed (0.1 kph)
    // Description:
    //      Excessive speed
    // Value: 
    //      0:2 - [UInt16] Definition of excess speed in 0.1 KPH units
    //            Valid range: 0.1 to 6553.5 KPH (0 means this feature is disabled)
    // Special data length rules:
    //      - A 0-length value indicates that this feature is disabled
    // Notes:
    //      - An excess speed event will be generated if the current speed exceeds this 
    //        value

#define PROP_MOTION_MOVING_INTRVL       0xF725