props.h

Open DMT Client C Source code

    // Notes:
    //      - This value must be supplied by your GSM/GPRS airtime 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_DNS_2                 0xF3A4
    // Description: [optional]
    //      Communication settings DNS 2 
    // Value: 
    //      0:X - [ASCIIZ] DNS ip address (secondary)
    // Special data length rules:
    //      - A 0-length value indicates that DNS-2 is not available.
    // Notes:
    //      - This value must be supplied by your GSM/GPRS airtime 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_CONNECTION            0xF3A5
    // Description: [optional]
    //      Connection name (WindowsCE)
    // Value: 
    //      0:X - [ASCIIZ] connection name as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the connection name is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_NAME              0xF3A6
    // Description: [optional]
    //      Communication settings APN name
    // Value: 
    //      0:X - [ASCIIZ] communication settings as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the APN name is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - This value must be supplied by your GSM/GPRS airtime service provider.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_SERVER            0xF3A7
    // Description: [optional]
    //      Communication settings APN server/domain
    // Value: 
    //      0:X - [ASCIIZ] communication settings as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the APN server/domain is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - This value must be supplied by your GSM/GPRS airtime service provider.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_USER              0xF3A8
    // Description: [optional]
    //      Communication settings APN user
    // Value: 
    //      0:X - [ASCIIZ] communication settings as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the APN user is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - This value must be supplied by your GSM/GPRS airtime service provider.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_PASSWORD          0xF3A9
    // Description: [optional]
    //      Communication settings APN password
    // Value: 
    //      0:X - [ASCIIZ] APN password as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the APN password is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - This value must be supplied by your GSM/GPRS airtime service provider.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_PHONE             0xF3AA
    // Description: [optional]
    //      Communication settings APN phone number
    // Value: 
    //      0:X - [ASCIIZ] APN phone number as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the phone number is not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_APN_SETTINGS          0xF3AC // was 0xF3AA
    // Description: [optional]
    //      General communication settings not specified elsewhere
    // Value: 
    //      0:X - [ASCIIZ] communication settings as required by the client device.
    // Special data length rules:
    //      - A 0-length value indicates that the APN settings are not available.
    // Notes:
    //      - The format of this ASCIIZ value is defined by the client device.
    //      - This value must be supplied by your GSM/GPRS airtime service provider.
    //      - The terminating null ('0') need not be included in the payload

#define PROP_COMM_MIN_SIGNAL            0xF3AD
    // Description: [optional]
    //      Communication settings minimum signal strength
    // Value: 
    //      0:1 - [UInt8] Minimum signal strength required to establish connection
    // Notes:
    //      - This is typically a value between 0 and 31 inclusive.  The client
    //        may use this value to compare against the signal strength returned
    //        from a "AT+CSQ" comment sent to the modem.

#define PROP_COMM_ACCESS_PIN            0xF3AF
    // Description: [optional]
    //      Access PIN/Password
    // Value:
    //      0:8 - [UInt8(8)] 8-byte access pin code
    // Special data length rules:
    //      - If the client wishes to keep this value a secret, it may choose to always 
    //        return a 0-length property payload.
    // Notes:
    //      - This value may be used for any access control purpose the client deems 
    //        necessary.

// ----------------------------------------------------------------------------
// Packet/Data format properties:

#define PROP_COMM_CUSTOM_FORMATS        0xF3C0
    // Description: [optional]
    //      True if server supports custom formats for this client
    // Value: 
    //      0:1 - 1 if server supports custom formats, 0 otherwise.
    // Special data length rules:
    //      - A 0-length value indicates that custom formats are not supported.
    // Notes:
    //      - This is a hint to whether or not the DMT service provider will support
    //        custom formats from this device.
    
#define PROP_COMM_ENCODINGS             0xF3C1
    // Description: [optional]
    //      Mask indicating the encodings supported by the server.
    // Value: 
    //      0:1 - Bitmask indicating supported encodings
    //          0x01 - Binary (always true)
    //          0x02 - Ascii Base64 (always true)
    //          0x04 - Ascii Hex (always true)
    //          0x08 - Ascii CSV (server support is optional)
    //          0xF0 - reserved
    // Special data length rules:
    //      - All servers must support Binary, Ascii Hex, and Ascii Base64.
    //      - Server support for CSV is optional.
    // Notes:
    //      - This is a hint to whether or not the DMT service provider will support
    //        the specified encoding for this device.
    //      - Since Binay, Hex, and Base64 must be supported by the DMT service
    //        provider, this essentially indicate whether the encoding CSV is supported
    //        by the DMT service provider.

#define PROP_COMM_BYTES_READ            0xF3F1
    // Description: [optional]
    //      Number of bytes read by client
    // Value: 
    //      0:4 - [UInt32] read byte count
    //            Valid range: 0 to 4294967295
    // Notes:
    //      - This is for information purposes only and the client is not required
    //      to implement this property.
    
#define PROP_COMM_BYTES_WRITTEN         0xF3F2
    // Description: [optional]
    //      Number of bytes written by client
    // Value: 
    //      0:4 - [UInt32] write byte count
    //            Valid range: 0 to 4294967295
    // Notes:
    //      - This is for information purposes only and the client is not required
    //      to implement this property.

// ----------------------------------------------------------------------------
// GPS config properties:

#define PROP_GPS_SAMPLE_RATE            0xF511
    // Description:
    //      GPS sample interval
    // Value: 
    //      0:2 - [UInt16] Number of seconds between GPS sampling
    //            Valid range: 1 to 65535 seconds (the effect of 0 is defined by the client)
    // Special data length rules:
    //      - The client/server must send at least 1 byte.
    // Notes:
    //      - This value represent the amount of time to wait between GPS  
    //      location acquisition and analysis.  This value is typically a
    //      short amount of time, somewhere between 5 and 30 seconds

#define PROP_GPS_AQUIRE_WAIT            0xF512
    // Description:
    //      Amount of time to block when waiting for a current GPS fix
    // Value: 
    //      0:2 - [UInt16] Number of milliseconds to block
    //            Valid range: 1 to 65535 milliseconds 
    //            The effect of 0 is defined by the client, but would typically mean
    //            that last valid fix should be immediately used.
    // Special data length rules:
    //      - The client/server must send at least 1 byte.
    // Notes:
    //      - This value respresent the amount of time to block waiting for
    //      a valid current GPS fix.
    //      - This value should be in the range of 0 to 5000 milliseconds.
    //      - '0' is defined by the client, but typically means that last valid fix should 
    //      be immediately used.
    
#define PROP_GPS_EXPIRATION             0xF513
    // Description:
    //      GPS Expiration
    // Value: 
    //      0:2 - [UInt16] Number of seconds after which the GPS fix is considered stale
    //            Valid range: 1 to 65535 sec (0 means this feature is disabled)
    // Special data length rules:
    //      - The value should be at least 1 byte.
    // Notes:
    //      - The behavior of the client when a GPS fix has expired is unspecified.
    //      The client may wish to send a diagnostic/error message to the server.
    
#define PROP_GPS_CLOCK_DELTA            0xF515
    // Description:
    //      Update system clock if difference exceeds value [optional]
    // Value: 
    //      0:2 - [UInt16] Number of seconds that the system clock must be out of sync
    //            with the GPS clock in order to force a time update of the system clock.
    // Special data length rules:
    //      - The value should be at least 1 byte.
    // Notes:
    //      - If non-zero, the client should check the GPS clock against the system clock
    //      and update the system clock if the delta is greater that (or equal to) this
    //      delta value.
    //      - A value of zero is an indicator to the client that the system clock should
    //      not be sync'ed to the GPS clock.
    //      - This is an optional feature.  The client may wish to never update the
    //      system clock, always update the system clock based on some fixed delta, or 
    //      choose to update the system clock based on this property value.

#define PROP_GPS_ACCURACY               0xF521
    // Description:
    //      GPS Accuracy threshold [optional]
    // Value: 
    //      0:2 - [UInt16] GPS accuracy threshold in meters.
    //            Valid range: 0 to 65535 meters (0 means the feature is not supported)
    // Special data length rules:
    //      - The value should be 2 bytes.  A 0-length value indicates that the feature 
    //      is not supported.
    // Notes:
    //      - A GPS fix will be rejected if it's accuracy falls outside this threshold.
    //      For example, if the value is set to 80 meters and the accuracy of a given
    //      GPS fix is determined to be 100 meters, then the GPS fix should be rejected
    //      and another GPS fix should be aquired.
    //      - Support for this property is optional (not all clients may have the
    //      ability to determine the accuracy of a GPS fix).  The client may return the
    //      error DIAG_PROPERTY_INVALID_ID if it cannot support this property.

#define PROP_GPS_MIN_SPEED              0xF522
    // Description:
    //      GPS Minimum speed
    // Value: 
    //      0:2 - [UInt16] Minimum GPS speed in 0.1 KPH units 
    //            Valid range: 0.0 to 6553.5 kph (0.0 means no minimum speed)
    // Special data length rules:
    //      - A 0-length value indicates no minimum speed
    // Notes:
    //      - GPS reported speed values less-than, or equals-to, this value will be
    //      considered stopped and will be reported in location events as 0 KPH.
    //      - The purpose of this property is to adjust for inaccuracies in some
    //      GPS modules which can report a significant speed value, even when the
    //      device is not moving.