statcode.h

Open DMT Client C Source code

#define STATUS_OUTPUT_OFF           0xF40A
    // Description:
    //      Output turned OFF
    // Notes:
    //      - Client should include FIELD_OUTPUT_ID in the event packet,
    //      otherwise this status code would have no meaning.
    //      - This status code may be used to indicate that an arbitrary output
    //      'thing' turned OFF, and the 'thing' can be identified by the 'Output ID'.
    //      This 'ID' can also represent the index of a digital output.

#define STATUS_INPUT_ON_00          0xF420
#define STATUS_INPUT_ON_01          0xF421
#define STATUS_INPUT_ON_02          0xF422
#define STATUS_INPUT_ON_03          0xF423
#define STATUS_INPUT_ON_04          0xF424
#define STATUS_INPUT_ON_05          0xF425
#define STATUS_INPUT_ON_06          0xF426
#define STATUS_INPUT_ON_07          0xF427
#define STATUS_INPUT_ON_08          0xF428
#define STATUS_INPUT_ON_09          0xF429
#define STATUS_INPUT_ON_10          0xF42A
#define STATUS_INPUT_ON_11          0xF42B
#define STATUS_INPUT_ON_12          0xF42C
#define STATUS_INPUT_ON_13          0xF42D
#define STATUS_INPUT_ON_14          0xF42E
#define STATUS_INPUT_ON_15          0xF42F
    // Description:
    //      Digital input state changed to ON

#define STATUS_INPUT_OFF_00         0xF440
#define STATUS_INPUT_OFF_01         0xF441
#define STATUS_INPUT_OFF_02         0xF442
#define STATUS_INPUT_OFF_03         0xF443
#define STATUS_INPUT_OFF_04         0xF444
#define STATUS_INPUT_OFF_05         0xF445
#define STATUS_INPUT_OFF_06         0xF446
#define STATUS_INPUT_OFF_07         0xF447
#define STATUS_INPUT_OFF_08         0xF448
#define STATUS_INPUT_OFF_09         0xF449
#define STATUS_INPUT_OFF_10         0xF44A
#define STATUS_INPUT_OFF_11         0xF44B
#define STATUS_INPUT_OFF_12         0xF44C
#define STATUS_INPUT_OFF_13         0xF44D
#define STATUS_INPUT_OFF_14         0xF44E
#define STATUS_INPUT_OFF_15         0xF44F
    // Description:
    //      Digital input state changed to OFF

#define STATUS_OUTPUT_ON_00         0xF460
#define STATUS_OUTPUT_ON_01         0xF461
#define STATUS_OUTPUT_ON_02         0xF462
#define STATUS_OUTPUT_ON_03         0xF463
#define STATUS_OUTPUT_ON_04         0xF464
#define STATUS_OUTPUT_ON_05         0xF465
#define STATUS_OUTPUT_ON_06         0xF466
#define STATUS_OUTPUT_ON_07         0xF467
    // Description:
    //      Digital output state set to ON

#define STATUS_OUTPUT_OFF_00        0xF480
#define STATUS_OUTPUT_OFF_01        0xF481
#define STATUS_OUTPUT_OFF_02        0xF482
#define STATUS_OUTPUT_OFF_03        0xF483
#define STATUS_OUTPUT_OFF_04        0xF484
#define STATUS_OUTPUT_OFF_05        0xF485
#define STATUS_OUTPUT_OFF_06        0xF486
#define STATUS_OUTPUT_OFF_07        0xF487
    // Description:
    //      Digital output state set to OFF

#define STATUS_ELAPSED_00           0xF4A0
#define STATUS_ELAPSED_01           0xF4A1
#define STATUS_ELAPSED_02           0xF4A2
#define STATUS_ELAPSED_03           0xF4A3
#define STATUS_ELAPSED_04           0xF4A4
#define STATUS_ELAPSED_05           0xF4A5
#define STATUS_ELAPSED_06           0xF4A6
#define STATUS_ELAPSED_07           0xF4A7
    // Description:
    //      Elapsed time
    // Notes:
    //      - Client should include FIELD_ELAPSED_TIME in the event packet,
    //      otherwise this status code would have no meaning.

#define STATUS_ELAPSED_LIMIT_00     0xF4B0
#define STATUS_ELAPSED_LIMIT_01     0xF4B1
#define STATUS_ELAPSED_LIMIT_02     0xF4B2
#define STATUS_ELAPSED_LIMIT_03     0xF4B3
#define STATUS_ELAPSED_LIMIT_04     0xF4B4
#define STATUS_ELAPSED_LIMIT_05     0xF4B5
#define STATUS_ELAPSED_LIMIT_06     0xF4B6
#define STATUS_ELAPSED_LIMIT_07     0xF4B7
    // Description:
    //      Elapsed timer has exceeded a set limit
    // Notes:
    //      - Client should include FIELD_ELAPSED_TIME in the event packet,
    //      otherwise this status code would have no meaning.

// ----------------------------------------------------------------------------
// Analog/etc sensor values (extra data): 0xF600 to 0xF6FF

#define STATUS_SENSOR32_0           0xF600
#define STATUS_SENSOR32_1           0xF601
#define STATUS_SENSOR32_2           0xF602
#define STATUS_SENSOR32_3           0xF603
#define STATUS_SENSOR32_4           0xF604
#define STATUS_SENSOR32_5           0xF605
#define STATUS_SENSOR32_6           0xF606
#define STATUS_SENSOR32_7           0xF607
    // Description:
    //      32-bit unsigned sensor value
    // Notes:
    //      - Client should include FIELD_SENSOR32 in the event packet,
    //      otherwise this status code would have no meaning.
    //      - The server must be able to convert this 32-bit value to something
    //      meaningful to the user.  This can be done using the following formula:
    //         Actual_Value = ((double)Sensor32_Value * <Gain>) + <Offset>;
    //      Where <Gain> & <Offset> are user configurable values provided at setup.
    //      For instance: Assume Sensor32-0 contains a temperature value that can
    //      have a range of -40.0C to +125.0C.  The client would encode -14.7C
    //      by adding 40.0 and multiplying by 10.0.  The resulting value would be
    //      253.  The server would then be configured to know how to convert this
    //      value back into the proper temperature using the above formula by
    //      substituting 0.1 for <Gain>, and -40.0 for <Offset>: eg.
    //          -14.7 = ((double)253 * 0.1) + (-40.0);

#define STATUS_SENSOR32_RANGE_0     0xF620
#define STATUS_SENSOR32_RANGE_1     0xF621
#define STATUS_SENSOR32_RANGE_2     0xF622
#define STATUS_SENSOR32_RANGE_3     0xF623
#define STATUS_SENSOR32_RANGE_4     0xF624
#define STATUS_SENSOR32_RANGE_5     0xF625
#define STATUS_SENSOR32_RANGE_6     0xF626
#define STATUS_SENSOR32_RANGE_7     0xF627
    // Description:
    //      32-bit unsigned sensor value out-of-range violation
    // Notes:
    //      - Client should include FIELD_SENSOR32 in the event packet,
    //      otherwise this status code would have no meaning.

// ----------------------------------------------------------------------------
// Temperature sensor values (extra data): 0xF700 to 0xF7FF

#define STATUS_TEMPERATURE_0        0xF710
#define STATUS_TEMPERATURE_1        0xF711
#define STATUS_TEMPERATURE_2        0xF712
#define STATUS_TEMPERATURE_3        0xF713
#define STATUS_TEMPERATURE_4        0xF714
#define STATUS_TEMPERATURE_5        0xF715
#define STATUS_TEMPERATURE_6        0xF716
#define STATUS_TEMPERATURE_7        0xF717
    // Description:
    //      Temperature value
    // Notes:
    //      - Client should include at least the field FIELD_TEMP_AVER in the 
    //      event packet, and may also wish to include FIELD_TEMP_LOW and
    //      FIELD_TEMP_HIGH.

#define STATUS_TEMPERATURE_RANGE_0  0xF730
#define STATUS_TEMPERATURE_RANGE_1  0xF731
#define STATUS_TEMPERATURE_RANGE_2  0xF732
#define STATUS_TEMPERATURE_RANGE_3  0xF733
#define STATUS_TEMPERATURE_RANGE_4  0xF734
#define STATUS_TEMPERATURE_RANGE_5  0xF735
#define STATUS_TEMPERATURE_RANGE_6  0xF736
#define STATUS_TEMPERATURE_RANGE_7  0xF737
    // Description:
    //      Temperature value out-of-range [low/high/average]
    // Notes:
    //      - Client should include at least one of the fields FIELD_TEMP_AVER,
    //      FIELD_TEMP_LOW, or FIELD_TEMP_HIGH.

#define STATUS_TEMPERATURE          0xF7F1
    // Description:
    //      All temperature averages [aver/aver/aver/...]

// ----------------------------------------------------------------------------
// Miscellaneous: 0xF800 to 0xF8FF

#define STATUS_LOGIN                0xF811
    // Description:
    //      Generic 'login'

#define STATUS_LOGOUT               0xF812
    // Description:
    //      Generic 'logout'

#define STATUS_CONNECT              0xF821
    // Description:
    //      Connect/Hook/On

#define STATUS_DISCONNECT           0xF822
    // Description:
    //      Disconnect/Drop/Off

#define STATUS_ACK                  0xF831
    // Description:
    //      Acknowledge

#define STATUS_NAK                  0xF832
    // Description:
    //      Negative Acknowledge

// ----------------------------------------------------------------------------
// OBC/J1708 status: 0xF900 to 0xF9FF

#define STATUS_OBC_FAULT            0xF911
    // Description:
    //      OBC/J1708 fault code occurred.
    // Notes:
    //      - Client should include the field FIELD_OBC_J1708_FAULT.

#define STATUS_OBC_RANGE            0xF920
    // Description:
    //      Generic OBC/J1708 value out-of-range
    // Notes:
    //      - Client should include at least one of the fields FIELD_OBC_VALUE,
    //      or one of the other FIELD_OBC_xxxxx fields.

#define STATUS_OBC_RPM_RANGE        0xF922
    // Description:
    //      OBC/J1708 RPM out-of-range
    // Notes:
    //      - Client should include the field FIELD_OBC_ENGINE_RPM.

#define STATUS_OBC_FUEL_RANGE       0xF924
    // Description:
    //      OBC/J1708 Fuel level out-of-range (ie. to low)
    // Notes:
    //      - Client should include the field FIELD_OBC_FUEL_LEVEL.

#define STATUS_OBC_OIL_RANGE        0xF926
    // Description:
    //      OBC/J1708 Oil level out-of-range (ie. to low)

#define STATUS_OBC_TEMP_RANGE       0xF928
    // Description:
    //      OBC/J1708 Temperature out-of-range
    // Notes:
    //      - Client should include at least one of the fields FIELD_OBC_xxxx
    //      fields which indicates a J1708 temperature out-of-range.

// ----------------------------------------------------------------------------
// Internal device status

#define STATUS_LOW_BATTERY          0xFD10
    // Description:
    //      Low battery indicator

#define STATUS_POWER_FAILURE        0xFD13
    // Description:
    //      Power-failure indicator

// ----------------------------------------------------------------------------

#ifdef __cplusplus
}
#endif
#endif