Struct PulseWidthEncoder

pub struct PulseWidthEncoder<P, F> { /* private fields */ }

Datagram to configure pulse width encoder table.

The pulse width encoder table is a table to determine the pulse width (or duty ratio) from the intensity. In the firmware, the intensity (0-255) is used as the index of the table to determine the pulse width. For firmware v11 or later, the period of the ultrasound is mapped to 512, therefore, the ultrasound output becomes maximum when the pulse width is 256 (50% in duty ratio). For firmware v10, the period of the ultrasound is mapped to 256, therefore, the ultrasound output becomes maximum when the pulse width is 128 (50% in duty ratio).

The default table is set by the arcsin function so that Intensity is linearly proportional to output ultrasound pressure; that is, table[i] = round(T*arcsin(i/255)/π) where T is the period of the ultrasound.

Example

To set the pulse width encoder table, please specify a function that takes the index of the table as an argument and returns the pulse width for each device.

The following example sets the pulse width to be linearly proportional to the intensity for all devices.

// For firmware version 11 or later
PulseWidthEncoder::new(|_dev| |i| PulseWidth::<9, u16>::from_duty(i.0 as f32 / 510.).unwrap());
// For firmware version 10
PulseWidthEncoder::new(|_dev| |i| PulseWidth::<8, u8>::from_duty(i.0 as f32 / 510.).unwrap());

Implementations

impl<const BITS: usize, T: Copy + TryFrom<usize> + Zero + PartialOrd, H: Fn(Intensity) -> PulseWidth<BITS, T> + Send + Sync, F: Fn(&Device) -> H> PulseWidthEncoder<PulseWidth<BITS, T>, F>

pub const fn new(f: F) -> Self

Creates a new PulseWidthEncoder.

Trait Implementations

impl<P: Clone, F: Clone> Clone for PulseWidthEncoder<P, F>

fn clone(&self) -> PulseWidthEncoder<P, F>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const BITS: usize, T: Copy + TryFrom<usize> + Zero + PartialOrd, H: Fn(Intensity) -> PulseWidth<BITS, T> + Send + Sync, F: Fn(&Device) -> H> Datagram for PulseWidthEncoder<PulseWidth<BITS, T>, F>

fn option(&self) -> DatagramOption

Returns the option of the datagram.

impl<P, F> Debug for PulseWidthEncoder<P, F>

where PhantomData<P>: Debug,

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

Formats the value using the given formatter.

impl<const BITS: usize, T: Copy + TryFrom<usize> + Zero + PartialOrd> Default for PulseWidthEncoder<PulseWidth<BITS, T>, fn(&Device) -> fn(Intensity) -> PulseWidth<BITS, T>>

fn default() -> Self

Returns the “default value” for a type.