CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


hardware:cflink:ir-module

IR Port CFLink Protocol

The following documentation describes the CFLink protocol for controlling IR devices via any device with IR Ports.
This includes IR modules and standalone devices such as the CF Mini, IR Blaster and Solo.

Transmission Messages

SND - Send IR

The SND (Send) command is used to send an IR command via one or more IR ports across one or more modules/devices.

Data

  • <MODULE> = The module number to send the IR via. 2 chars, uppercase 'M' followed by the module number.
    • eg. M1 = Module 1, M4 = Module 4.
  • <PORT> = The IR port in the specified module to send the IR data via. 3 chars, uppercase 'P' followed by the port number (2 digits) eg. P01 = Port 1, P04 = Port 4, PZZ = All ports on the module.
  • <IR_FORMAT> = The format of the <IR_DATA> to send:
    • DBA - Send an IR command from the internal database.
    • MEM - Send a learned IR code that is stored on the device memory.
    • RAW - Send an IR code in raw hex format, eg. Pronto CCF codes.
    • STR - Send an IR code in CommandFusion's proprietary format.
    • 232 - Send an RS232 command via an IR port that supports 1-way RS232 transmission.
  • <IR_DATA> = The data of the IR code to send. The format depends on the <IR_FORMAT> chosen:
    • DBA - <DEVICETYPE>:<CODESET>:<KEY> - See the IR Database Documentation for more details.
      • <DEVICE_TYPE> = The number corresponding to the type of device. (2 digits)
      • <CODE_SET> = The code set number from the Database table.
      • <KEY> = The key code from the Database table.
    • MEM - <DEVICE>:<FUNCTION>
      • <DEVICE> = The name of the device, as stored in the IR file.
      • <FUNCTION> = The name of the IR function to send, within the device IR file.
    • RAW - <HEX_CODE> - The raw hex code (Often called CCF) to send. Only 'learned' IR codes (starting with 0000) are allowed.
    • STR - <CFIRFORMAT> - See the CommandFusion IR Format Documentation for more details.
    • 232 - <RS232_DATA> - This is the raw RS232 data that you want to send. Only IR ports with 1-way RS232 support can use this option.

Note that a single SND command can contain multiple modules and ports to send to, using the standard port and module separators.

Reply

If sending multiple IR commands via a single CFLink message, the reply will only happen after all IR commands have been sent.

Example

Error

  • 003 = Invalid Port Number
  • 004 = Invalid Module Number
  • 450 = Invalid IR Format Type
  • 451 = Invalid IR Database Parameters
  • 452 = Invalid IR Memory Parameters
  • 453 = Invalid IR Raw Hex Code
  • 454 = Invalid CF IR format
hardware/cflink/ir-module.txt · Last modified: 2018/06/12 09:30 by jarrod