Struct irp::Irp

pub struct Irp {
    pub general_spec: GeneralSpec,
    pub stream: Rc<Expression>,
    pub definitions: Vec<Expression>,
    pub parameters: Vec<ParameterSpec>,
}

A parsed IRP notation, which can be used for encoding and decoding

Fields

general_spec: GeneralSpec

stream: Rc<Expression>

definitions: Vec<Expression>

parameters: Vec<ParameterSpec>

Implementations

impl Irp

pub fn compile(&self) -> Result<NFA, String>

Generate an NFA decoder for this IRP. This may fail if it is impossible to generate a decoder for this Irp.

impl Irp

pub fn encode<'a>(
&'a self,
vars: Vartable<'a>,
repeats: u64
) -> Result<Message, String>

Render it to raw IR with the given variables

pub fn encode_pronto<'a>(&'a self, vars: Vartable<'a>) -> Result<Pronto, String>

Render it to pronto hex with the given variables. Any trailing part after the repeating section cannot be represented in pronto hex, so this is dropped. This part of the IR is commonly use for a “key up” type message. This always produces pronto hex long codes, never the short variant.

impl Irp

Parse an irp into an AST type representation

pub fn parse(input: &str) -> Result<Irp, String>

pub fn carrier(&self) -> Option<i64>

The carrier frequency in Hertz. None means unknown, Some(0) means unmodulated.

pub fn duty_cycle(&self) -> Option<u8>

Duty cycle of the carrier pulse wave. Between 1% and 99%.

pub fn lsb(&self) -> bool

Bit-ordering rule to use when converting variables from binary form to bit sequences. When true, variables are encoded for transmission with their least significant bit first, otherwise the order is reversed.

pub fn unit(&self) -> f64

Unit of time that may be used in durations and extents. The default unit is 1.0 microseconds. If a carrier frequency is defined, the unit may also be defined in terms of a number of carrier frequency pulses.

Trait Implementations

impl Debug for Irp

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.