Struct irp::Irp

pub struct Irp {
    pub parameters: Vec<ParameterSpec>,
    /* private fields */
}

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

Fields

parameters: Vec<ParameterSpec>

Implementations

impl Irp

pub fn compile(&self, options: &Options<'_>) -> Result<DFA, String>

Generate an DFA decoder state machine for this IRP

impl Irp

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

Generate an NFA decoder for this IRP. This may fail if it is impossible for this IRP.

impl Irp

pub fn encode<'a>(&'a self, vars: Vartable<'a>) -> Result<[Vec<u32>; 3], String>

Render it to raw IR with the given variables, separated into intro, repeat, ending

pub fn encode_raw<'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. This always produces pronto hex long codes, never the short variant.

impl Irp

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

Parse an irp and validate. The result can be used for encoding or decoding.

pub fn carrier(&self) -> i64

The carrier frequency in Hertz. 0 means unmodulated (no carrier)

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) -> Rational64

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.

pub fn has_ending(&self) -> bool

Does this IRP have an ending part

pub fn normal_form(&self) -> String

Give the IRP in normal form

Trait Implementations

impl Debug for Irp

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

Formats the value using the given formatter.