props.h

Open DMT Client C Source code

    //      - The read-only attribute of this property may be enforced by the client.

#define PROP_STATE_USER_TIME            0xF118
    // Description:
    //      [Read-Only] User ID time
    // Value:
    //      0:4 - [UInt32] Number of seconds since midnight Jan 1, 1970 GMT
    // Special data length rules:
    //      - This timestamp should be initialized automatically at the time the
    //      PROP_STATE_USER_ID value was set (programmatically, or otherwise.
    //      - The client must either respond with an exact 4 byte value, or may send
    //      a 0-length value indicating to the server that the client cannot
    //      provide the user-time.
    // Notes:
    //      - The read-only attribute of this property may be enforced by the client.

#define PROP_STATE_TIME                 0xF121
    // Description: [optional]
    //      [Read-Only] Current time of device
    // Value:
    //      0:4 - [UInt32] Number of seconds since midnight Jan 1, 1970 GMT
    //            Valid value is defined by the current time
    // Special data length rules:
    //      - The client must either respond with an exact 4 byte value, or may send
    //      a 0-length value indicating to the server that the client cannot
    //      provide the system time.
    // Note:
    //      - Implementation of this property is optional.  However,
    //      if the client cannot, or does not wish to support this feature, it
    //      should at least return a 0-length value.
    //      - Typically this property is read-only, however this is enforced by
    //      the client, not the server.  The client may allow this value to be set
    //      if necessary.

#define PROP_STATE_GPS                  0xF123
    // Description: [optional]
    //      [Read-Only] Latest (current) GPS fix
    // Value:
    //    10/14-byte length
    //      0:4 - [UInt32] GPS fix time
    //            Valid value is defined by the current time
    //      4:3 - [UInt24] standard-resolution encoded latitude
    //            See "Encoding the GPS Latitude/Longitude"
    //      7:3 - [UInt24] standard-resolution encoded longitude
    //            See "Encoding the GPS Latitude/Longitude"
    //     10:4 - [UInt32] optional odometer value in meters
    //    or
    //    12/16-byte length
    //      0:4 - [UInt32] GPS fix time
    //            Valid value is defined by the current time
    //      4:4 - [UInt32] high-resolution encoded latitude
    //            See "Encoding the GPS Latitude/Longitude"
    //      8:4 - [UInt32] high-resolution encoded longitude
    //            See "Encoding the GPS Latitude/Longitude"
    //     12:4 - [UInt32] optional odometer value in meters
    //    or
    //      0:0 - this property is not supported
    // Special data length rules:
    //      - The client must respond with either a 10/14-byte or 12/16-byte length.
    //      Or the client may respond with a 0-length value if this feature cannot be
    //      supported.
    // Notes:
    //      - Depending on the degree of accuracy that the client wishes to provide,
    //      the client may return either a 6-byte, or 8-byte, encoded Lat/Lon.
    //      If the client cannot, or does not wish to support this feature, it
    //      should at least return a 0-length value.
    //      - This property should be considered read-only.
    //      - Server note: The server will infer from the length of the data payload
    //      which type of encoding is used.  A data payload of 10 bytes will indicate
    //      a standard-resolution encoding, and a length of 12 bytes will indicating
    //      a high-resolution encoding.  If the data payload is 0-length, the server
    //      will assume that this property feature is not supported by this client.
    
#define PROP_STATE_GPS_DIAGNOSTIC       0xF124
    // Description: [optional]
    //      [Read-Only] Latest (current) GPS diagnostic information
    // Value:
    //      0:4 - [UInt32] Last GPS sample time
    //      4:4 - [UInt32] Last GPS valid fix time
    //      8:4 - [UInt32] Number of valid GPS fixes since reboot
    //     12:4 - [UInt32] Number of invalid GPS fixes since reboot
    //     16:4 - [UInt32] Number of forced GPS restarts
    // Notes:
    //      - This property is used by the client to provide diagnostic information
    //      regarding the current health of the GPS module.

#define PROP_STATE_QUEUED_EVENTS        0xF131
    // Description: [optional]
    //      [Read-Only] Event counts (queue for transmission, and total)
    // Value:
    //      0:4 - [UInt32] Number of queued, un-acknowledged, events
    //      0:4 - [UInt32] Total number of events generated (since last reboot)

#define PROP_STATE_DEV_DIAGNOSTIC       0xF141
    // Description: [optional]
    //      [Read-Only] Device diagnostics
    // Value:
    //      0:4 - [UInt32] The device reset count (either manual or forced)
    //      4:4 - [UInt32] supply voltage (in millivolts)
    //      8:4 - [UInt32] reserved
    //     12:4 - [UInt32] reserved
    //     16:4 - [UInt32] reserved

// ----------------------------------------------------------------------------
// Communication protocol properties:

#define PROP_COMM_SPEAK_FIRST           0xF303
    // Description:
    //      If 'true', client is expected to initiate the conversation with the server.
    // Value: 
    //      0:1 - [utBool] Non-Zero if client is expected to initiate conversation
    // Special data length rules:
    //      - The client must send the 1 required byte
    //      - The server must send the 1 required byte
    // Notes:
    //      - This value may be read-only on the client.

#define PROP_COMM_FIRST_BRIEF           0xF305
    // Description:
    //      If 'true', client must send only ID and EOB packets on first packet block.  It 
    //      must not include any other packets.
    // Value: 
    //      0:1 - [utBool] Non-Zero if client is to send only ID and EOB packets on first packet 
    //            block.
    // Special data length rules:
    //      - The client must send the 1 required byte
    //      - The server must send the 1 required byte
    // Notes:
    //      - This value may be read-only on the client.

#define PROP_COMM_MAX_CONNECTIONS       0xF311
    // Description:
    //      Maximum number of allowed connections per time period
    // Value: 
    //      0:1 - [UInt8] Maximum total connections per time period (Duplex + Simplex)
    //            Valid range: 0 to 255 connections (0 means NO connections)
    //      1:1 - [UInt8] Maximum Duplex connections per time period
    //            Valid range: 0 to 255 connections (0 means NO Duplex connections)
    //      2:1 - [UInt8] Number of minutes over which the above limits apply
    //            Valid range: 0 to 240 minutes 
    //            (Rounded to floor 30 minute interval.  Max 240 minutes.)
    // Special data length rules:
    //      - The client should send the 3 required bytes
    //      - The server must send the 3 required bytes
    // Notes:
    //      - These values should match those provided by the level of service
    //      granted by the DMT service provider.
    //      - The number of total connections should always be >= the number of Duplex connections
    //      - The number of Duplex connection should be set to '0' if all messages are to
    //      transmitted via Simplex (eg. UDP).

#define PROP_COMM_MIN_XMIT_DELAY        0xF312
    // Description:
    //      Absolute minimum time delay (seconds) between transmit intervals
    // Value: 
    //      0:2 - [UInt16] Minimum time in seconds between transmissions
    //            Valid range: 0 to 65535 seconds (0 means no minimum)
    // Special data length rules:
    //      - The client should respond with at least the minimum length that can accurately
    //      represent the value.
    //      - The server must always send at least 1 byte.
    // Notes:
    //      - The device must never transmit more often than the interval specified by this 
    //      property (even for critical events).

#define PROP_COMM_MIN_XMIT_RATE         0xF313
    // Description:
    //      Minimum data transmit interval (seconds)
    // Value: 
    //      0:4 - [UInt32] Minimum time in seconds between transmissions of non-critical events.
    //            Valid range: 0 to 4294967295 seconds (the client may impose limits)
    // Special data length rules:
    //      - The client should respond with at least the minimum length that can accurately
    //      represent the value.
    //      - The server must always send at least 1 byte.
    // Notes:
    //      - For non-critical events, the device should never transmit more often than the 
    //      interval specified by this property.
    
#define PROP_COMM_MAX_XMIT_RATE         0xF315
    // Description:
    //      Maximum data transmit interval
    // Value: 
    //      0:4 - [UInt32] Maximum time in seconds between transmissions
    //            Valid range: 0 to 4294967295 seconds (the client may impose limits)
    // Special data length rules:
    //      - The client should respond with at least the minimum length that can accurately
    //      represent the value.
    //      - The server must always send at least 1 byte.
    // Notes:
    //      - If this amount of time passes without any data trasnmission, initiate a
    //      non-data transmission to see if the server wishes to send the client any
    //      information or reconfiguration.
    //      - This value should never be less than PROP_COMM_MIN_XMIT_RATE
    
#define PROP_COMM_MAX_DUP_EVENTS        0xF317
    // Description:
    //      Maximum events to send per block (Duplex connections)
    // Value: 
    //      0:1 - [UInt8] Maximum number of events to send per acknowledge block (1 to 255)
    //            Valid range: 1 to 255 events (the client/server may impose limits)
    // Special data length rules:
    //      - The client must alway send a 1 byte value.
    //      - The server must always send a 1 byte value.
    // Notes:
    //      - This value should be at least 1, but should not be greater than 128.  The
    //      server may refuse the data if greater than 128.
    
#define PROP_COMM_MAX_SIM_EVENTS        0xF318
    // Description:
    //      Maximum events to send per Simplex transmission
    // Value: 
    //      0:1 - [UInt8] Maximum number of events to send per Simplex transmission (1 to 255)
    //            Valid range: 1 to 255 events (the client may impose limits)
    // Special data length rules:
    //      - The client must alway send a 1 byte value.
    //      - The server must always send a 1 byte value.
    // Notes:
    //      - This value should be at least 1, but should not be greater than 16.  Since
    //      Simplex transmissions may not guarantee delivery (UDP does not), making this 
    //      value larger may result in a more significant data loss should a particular 
    //      message be lost.
    //      - Since Simplex transmissions may not guarantee delivery, only low priority, 
    //      non-critical messages should be sent via Simplex.

// ----------------------------------------------------------------------------
// Communication connection properties:

#define PROP_COMM_SETTINGS              0xF3A0
    // Description:
    //      Communication settings - as defined by device
    // Value: 
    //      0:X - [ASCIIZ] Device defined communication settings.
    // Special data length rules:
    //      - A 0-length value indicates that no communication settings are available.
    // Notes:
    //      - The format of the value payload is defined by the client device.
    //      - The terminating null ('0') need not be included in the payload
    //      - The client may choose to make this read-only.

#define PROP_COMM_HOST                  0xF3A1
    // Description: [optional]
    //      Communication settings host
    // Value: 
    //      0:X - [ASCIIZ] host name or ip address, identifier
    // Special data length rules:
    //      - A 0-length value indicates that no host name is available.
    // Notes:
    //      - This value must be supplied by your DMT service provider.
    //      - The terminating null ('0') need not be included in the payload
    //      - The client may choose to make this read-only.

#define PROP_COMM_PORT                  0xF3A2
    // Description: [optional]
    //      Communication settings port
    // Value: 
    //      0:2 - [UInt16] host port number for Duplex/Simplex communications.
    // Special data length rules:
    //      - The length must be large enough to accurately represent the port.
    //      - A 0-length value indicates that no port is specified.
    // Notes:
    //      - This value must be supplied by your DMT service provider.
    //      - The client may choose to make this read-only.

#define PROP_COMM_DNS_1                 0xF3A3
    // Description: [optional]
    //      Communication settings DNS 1 
    // Value: 
    //      0:X - [ASCIIZ] DNS ip address (primary)
    // Special data length rules:
    //      - A 0-length value indicates that DNS-1 is not available.