Struct IrMapping 

pub struct IrMapping<'a, B, const N: usize> { /* private fields */ }

Available on target_os=none only.

A generic device abstraction that maps IR remote button presses to user-defined button types.

Examples

use device_envoy::ir::{IrMapping, IrMappingStatic};
#[derive(Debug, Clone, Copy)]
enum RemoteButton { Power, Play, Stop }
async fn example(
    p: embassy_rp::Peripherals,
    spawner: embassy_executor::Spawner,
) -> device_envoy::Result<()> {
    let button_map = [
        (0x0000, 0x45, RemoteButton::Power),
        (0x0000, 0x0C, RemoteButton::Play),
        (0x0000, 0x08, RemoteButton::Stop),
    ];

    static IR_MAPPING_STATIC: IrMappingStatic = IrMapping::<RemoteButton, 3>::new_static();
    let ir_mapping: IrMapping<RemoteButton, 3> = IrMapping::new(&IR_MAPPING_STATIC, p.PIN_15, p.PIO0, &button_map, spawner)?;

    loop {
        let button = ir_mapping.wait_for_press().await;
        // Use button...
    }
}

Implementations

impl<'a, B, const N: usize> IrMapping<'a, B, N>

where B: Copy,

pub const fn new_static() -> IrMappingStatic

Create static channel resources for IR mapping events.

See IrMapping for usage examples.

pub fn new<P, PIO>( ir_mapping_static: &'static IrMappingStatic, pin: Peri<'static, P>, pio: Peri<'static, PIO>, button_map: &[(u16, u8, B)], spawner: Spawner, ) -> Result<Self>

where P: Pin + PioPin, PIO: IrPioPeripheral,

Create a new IR remote button mapper.

Parameters

• ir_mapping_static: Static reference to the channel resources
• pin: GPIO pin connected to the IR receiver
• pio: PIO peripheral to use (PIO0, PIO1, or PIO2)
• button_map: Array mapping (address, command) pairs to button types
• spawner: Embassy spawner for background task

See IrMapping for usage examples.

Errors

Returns an error if the background task cannot be spawned.

pub async fn wait_for_press(&self) -> B

Wait for the next recognized button press.

Ignores button presses that are not in the button map.

See IrMapping for usage examples.