kProtocolDef.h

Go to the documentation of this file.

#ifndef K_FIRESYNC_PROTOCOL_DEF_H
#define K_FIRESYNC_PROTOCOL_DEF_H

#include <kFireSync/kNodeDef.h>

kBeginHeader()

/*
 *  Note to implementers: These constants represent the top-level FireSync 6 protocol version.  Modification to the 
 *  Major or Minor components requires prior design approval. If the protocol version must be modified, please describe 
 *  the reason for the modification in the "FireSync 6 Protocol Versions" section of the FireSync Net Protocols design document.
 */
#define kFIRESYNC_PROTOCOL_VERSION_MAJOR        (6)           
#define kFIRESYNC_PROTOCOL_VERSION_MINOR        (3)           
#define kFIRESYNC_PROTOCOL_VERSION_RELEASE      (1)           

/* 
 * FDP-6 
 */

#define kFDP6_DEFAULT_PORT              (2016)
#define kFDP6_DEFAULT_VIRTUAL_PORT      (2020)

#define kFDP6_COMMAND_UPDATE                k64U(0xA08D2310D83C11E2)
#define kFDP6_COMMAND_SET_ADDRESS           k64U(0xB29C04156188709B)
#define kFDP6_COMMAND_FORCE_RESCUE          k64U(0xC266C1A704D74699)

/* 
 * FCP-6 
 */

#define kFCP6_DEFAULT_PORT      (2017)

#define kFCP6_COMMAND_WRITE_FIRMWARE                (0x0100) 
#define kFCP6_COMMAND_WRITE_FIRMWARE_EX             (0x0101) 
#define kFCP6_COMMAND_RESET                         (0x0110)

#define kFCP6_COMMAND_WRITE_FILE                    (0x0200) 
#define kFCP6_COMMAND_COPY_FILE                     (0x0201) 
#define kFCP6_COMMAND_READ_FILE                     (0x0202) 
#define kFCP6_COMMAND_DELETE_FILE                   (0x0203) 
#define kFCP6_COMMAND_GET_FILE_INFO                 (0x0204) 
#define kFCP6_COMMAND_WRITE_FILE_EX                 (0x0205) 
#define kFCP6_COMMAND_COPY_FILE_EX                  (0x0206) 
#define kFCP6_COMMAND_CREATE_DIRECTORY              (0x0210) 
#define kFCP6_COMMAND_DELETE_DIRECTORY              (0x0211) 
#define kFCP6_COMMAND_LIST_DIRECTORY_ENTRIES        (0x0212) 

#define kFCP6_COMMAND_SET_DEVICE_CONFIG             (0x0300) 
#define kFCP6_COMMAND_GET_DEVICE_CONFIG             (0x0301) 
#define kFCP6_COMMAND_COMMIT_DEVICE_CONFIG          (0x0302) 

#define kFCP6_COMMAND_SET_MODE_CONFIG               (0x0310) 
#define kFCP6_COMMAND_GET_MODE_CONFIG               (0x0311) 
#define kFCP6_COMMAND_LOAD_MODE_CONFIG              (0x0312) 
#define kFCP6_COMMAND_SAVE_MODE_CONFIG              (0x0313) 
#define kFCP6_COMMAND_COMMIT_MODE_CONFIG            (0x0314) 

#define kFCP6_COMMAND_VALIDATE_BLOCK_CONFIG         (0x0320) 

#define kFCP6_COMMAND_CAMERA_OVERRIDE               (0x0330) 
#define kFCP6_COMMAND_LIGHT_OVERRIDE                (0x0331)

#define kFCP6_COMMAND_LIST_PROCEDURES               (0x0400) 
#define kFCP6_COMMAND_INVOKE_PROCEDURE              (0x0401)

#define kFCP6_COMMAND_LIST_VARIABLES                (0x0410) 
#define kFCP6_COMMAND_GET_VARIABLE                  (0x0411) 
#define kFCP6_COMMAND_GET_VARIABLE_INFO             (0x0412) 
#define kFCP6_COMMAND_SET_VARIABLE                  (0x0413) 
#define kFCP6_COMMAND_DELETE_VARIABLE               (0x0414) 

#define kFCP6_COMMAND_VALIDATE_ACTION_CONFIG        (0x0420)
#define kFCP6_COMMAND_INVOKE_ACTION                 (0x0421)
#define kFCP6_COMMAND_INVOKE_NAMED_ACTION           (0x0422)

#define kFCP6_COMMAND_START                         (0x0500) 
#define kFCP6_COMMAND_STOP                          (0x0501) 
#define kFCP6_COMMAND_PAUSE                         (0x0502) 
#define kFCP6_COMMAND_RESUME                        (0x0503) 
#define kFCP6_COMMAND_ENGAGE                        (0x0504) 

#define kFCP6_COMMAND_START_REPLAY                  (0x0510) 
#define kFCP6_COMMAND_REPLAY                        (0x0511) 

#define kFCP6_COMMAND_SCHEDULE_EVENT                (0x0600) 
#define kFCP6_COMMAND_TRIGGER_EVENT                 (0x0601) 

#define kFCP6_COMMAND_SET_LIGHT_STATE               (0x0610) 
#define kFCP6_COMMAND_TRIGGER_LIGHT                 (0x0611)

#define kFCP6_COMMAND_SET_DIGITAL_OUTPUT            (0x0620) 
#define kFCP6_COMMAND_TRIGGER_DIGITAL_OUTPUT        (0x0621)

#define kFCP6_COMMAND_ENQUEUE_ANALOG_OUTPUT         (0x0630)

#define kFCP6_COMMAND_WRITE_RAM_IMAGE               (0x0640)
#define kFCP6_COMMAND_WRITE_PRNU                    (0x0641)
#define kFCP6_COMMAND_WRITE_FPN                     (0x0642)
#define kFCP6_COMMAND_WRITE_RANGE_LUT               (0x0643)
#define kFCP6_COMMAND_TRIGGER_CAMERA                (0x0644) 

#define kFCP6_COMMAND_LOAD_PROJECTOR_PATTERNS       (0x0650)

#define kFCP6_COMMAND_RESET_ENCODER                 (0x0660)

#define kFCP6_COMMAND_ENABLE_LED                    (0x0670)

#define kFCP6_COMMAND_SET_GPIO_DIRECTION            (0x0675) // removed in FS 6.1.13.40
#define kFCP6_COMMAND_GET_GPIO_DIRECTION            (0x0676) // removed in FS 6.1.13.40
#define kFCP6_COMMAND_SET_GPIO_STATE                (0x0677)
#define kFCP6_COMMAND_GET_GPIO_STATE                (0x0678)

#define kFCP6_COMMAND_WRITE_SERIAL_OUTPUT           (0x0680)

#define kFCP6_COMMAND_LOCK_OUT_LIGHT                (0x0690)
#define kFCP6_COMMAND_SET_LIGHT_MODEL               (0x0691)
#define kFCP6_COMMAND_GET_LIGHT_MODEL               (0x0692)
#define kFCP6_COMMAND_SET_LIGHT_POWER               (0x0693)
#define kFCP6_COMMAND_GET_LIGHT_POWER               (0x0694)

#define kFCP6_COMMAND_GET_INFO                      (0x0700) 
#define kFCP6_COMMAND_GET_STATE                     (0x0701) 
#define kFCP6_COMMAND_GET_NODE_STATS                (0x0710) 
#define kFCP6_COMMAND_GET_EVENT_STATS               (0x0711) 
#define kFCP6_COMMAND_GET_CAMERA_STATS              (0x0712) 
#define kFCP6_COMMAND_GET_LIGHT_STATS               (0x0713) 
#define kFCP6_COMMAND_GET_PROJECTOR_STATS           (0x0714) 
#define kFCP6_COMMAND_GET_ANALOG_STATS              (0x0715) 
#define kFCP6_COMMAND_GET_DIGITAL_STATS             (0x0716) 
#define kFCP6_COMMAND_GET_SERIAL_STATS              (0x0717) 

#define kFCP6_COMMAND_READ_REGISTERS                (0x0803)
#define kFCP6_COMMAND_READ_REGISTER_OVERRIDES       (0x0804)
#define kFCP6_COMMAND_WRITE_REGISTER_OVERRIDES      (0x0805)

#define kFCP6_COMMAND_READ_LOG_HISTORY              (0x0810)

#define kFCP6_COMMAND_I2C_READ                      (0x0820)
#define kFCP6_COMMAND_I2C_WRITE                     (0x0821)

#define kFCP6_COMMAND_RESET_IO_TEST                 (0x0900)
#define kFCP6_COMMAND_GET_IO_TEST_STATS             (0x0901)
#define kFCP6_COMMAND_READ_IO_TEST_SERIAL_DATA      (0x0902)

#define kFCP6_COMMAND_TEST_JIG_COMMAND              (0x0910)
#define kFCP6_COMMAND_GET_TEST_JIG_STATS            (0x0911)

#define kFCP6_COMMAND_GET_ORIENTATION_STATS         (0x0A00)
#define kFCP6_COMMAND_START_ORIENTATION_CALIBRATION (0x0A01)

 /* 
  * FHSP-6 
  */

#define kFHSP6_DEFAULT_PORT         (2018)


 /* 
  * FDSP-6 
  */

#define kFDSP6_DEFAULT_PORT         (2019)


#define kFDSP6_COMMAND_CONFIGURE_CHANNEL            (0x2000) 

kEndHeader()

#endif