====== IR Blaster CFLink Protocol ======

The following documentation is for the IR Blaster device CFLink protocol messages.

===== Transmission Messages =====

==== SND - Send IR ====

The ''SND'' (Send) command is used to send an IR command via one or more IR ports on the IR Blaster.

=== Data ===

<sxh cflink; light: true>
> [F2]<ID>[F3]TIRBSND[F4]<PORT>:<IR_FORMAT>:<IR_DATA>[F5][F5]
</sxh>

  * **<PORT>** = The IR port to send the IR data from. 3 chars, uppercase ''P'' followed by the port number (2 digits)
    *''P01'' = On-board Blaster output
    *''P02'' = Secondary emitter output
    *''PZZ'' = Send IR out both ports consecutively.
  * **<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. CCF codes.
    *''STR'' - Send an IR code in CommandFusion's proprietary format.
  * **<IR_DATA>** = The data of the IR code to send. The format depends on the <IR_FORMAT> chosen:
    *''DBA'' - <DEVICE_TYPE>:<CODE_SET>:<KEY> - See the [IR Database Documentation](irdatabase.html) 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'' - <CF_IR_FORMAT> - generated by [[hardware:quick-start:ir-learner|IR Learner software]]

Note that a single ''SND'' command can contain multiple ports to send to, using the [[hardware:cflink:cflink-introduction#port-separator|standard port separators]]

=== Reply ===

<sxh cflink; light: true>
// The reply does not echo the data sent in an effort to reduce bus traffic
< [F2]<ID>[F3]RIRBSND[F4][F5][F5]
</sxh>
If sending multiple IR commands via a single CFLink message, the reply will only happen after all IR commands have been sent.

=== Example ===

<sxh cflink; light: true>
// Send a CCF hex code via the Blaster output. Send a database IR code to the secondary emitter output.  
// From IR Blaster on CFLink ID [06].
> [F2][06][F3]TIRBSND[F4]P01:RAW:0000 0067 0000 0015 0060 0018 0030 0018 0018 0018 0030 0018 0018 0018 0030 0018 0018 0018 0018 0018 0018 0018 0030 0018 0018 0018 0030 0018 0030 0018 0030 0018 0018 0018 0018 0018 0030 0018 0018 0018 0018 0018 0030 0018 0018 0216|P02:DBA:06:1033:01[F5][F5]
// Reply
< [F2][06][F3]RIRBSND[F4][F5][F5]
</sxh>

=== Error ===

  * 003 = Invalid Port 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

===== Notifications =====

==== RCV - Receive IR Data ====

The ''RCV'' (Receive) notification is generated when either the on-board IR receiver, or the external IR receiver detects an IR signal.

=== Data ===

<sxh cflink; light: true>
< [F2]<ID>[F3]RIRBRCV[F4]<PORT>:<IR_DATA>[F5][F5]
</sxh>

  * **<PORT>** = The IR port that the IR data was received via. 3 chars, uppercase 'P' followed by the port number (2 digits)
    * ''P01'' = On-board Blaster output
    * ''P02'' = Secondary emitter output
  * **<IR_DATA>** = The IR data generated by the [[hardware:quick-start:ir-learner|IR Learner software]]

=== Example ===

<sxh cflink; light: true>
// IR Data is received via the on-board IR receiver, IR Blaster on CFLink ID [06]
< [F2][06][F3]RIRBRCV[F4]P01:0066016100160119001601320016011A0016011900160132001601310016011A0016[F5][F5]
</sxh>