6.1-roIRReceiver

Owned by Anonymous
Sept 27, 2021
1 min read

ON THIS PAGE


This object supports receiving arbitrary Infrared remote control codes using the NEC and RC5 protocols.

Object Creation: The roIRReceiver object is created with an associative array.

CreateObject("roIRReceiver", config As roAssociativeArray)

The associative array can contain the following parameters:

  • source: A string value indicating the source of the input.
    • "IR-in": The 3.5mm IR input/output connector (available on 4Kx42 and XDx32 models)
    • "GPIO": Pin 1 of the GPIO connector
    • "Iguana": The Iguanaworks IR transceiver. This source can support both NEC and RC5 encodings simultaneously.
  • encodings: An array indicating the required encodings.
    • "NEC"
    • "RC5" (supported on the Iguanaworks IR transceiver only)

 

NEC codes are expressed in 24 bits:

  • Bits 0-7: Button code
  • Bits 8-23: Manufacturer code

Note

If the manufacturer code is zero, then the code is considered to be intended for the Roku SoundBridge remote control.

 

The roIRReceiver object can generate the following events:

  • roIRDownEvent: Generates when a button is pressed.
  • roIRRepeatEvent: Generates when a button repeats.
  • roIRUpEvent (Iguanaworks IR transceiver only): Generates when a button is released.

ifUserData

SetUserData(user_data As Object)

Sets the user data that will be returned when events are raised.

GetUserData() As Object

Returns the user data that has previously been set via SetUserData(). It will return Invalid if no data has been set.

ifMessagePort

SetPort(port As roMessagePort)

Specifies the port that will receive events generated by the roIRReceiver instance.