autd3-driver 38.1.0

AUTD3 driver
Documentation
use std::{convert::Infallible, num::NonZeroU16};

use super::SilencerControlFlags;
use crate::{
    datagram::FixedUpdateRate,
    firmware::{
        operation::{Operation, OperationGenerator, implement::null::NullOp},
        tag::TypeTag,
    },
};

use autd3_core::geometry::Device;

#[repr(C, align(2))]
struct SilencerFixedUpdateRate {
    tag: TypeTag,
    flag: SilencerControlFlags,
    value_intensity: u16,
    value_phase: u16,
}

pub struct FixedUpdateRateOp {
    is_done: bool,
    intensity: NonZeroU16,
    phase: NonZeroU16,
}

impl FixedUpdateRateOp {
    pub(crate) const fn new(intensity: NonZeroU16, phase: NonZeroU16) -> Self {
        Self {
            is_done: false,
            intensity,
            phase,
        }
    }
}

impl Operation<'_> for FixedUpdateRateOp {
    type Error = Infallible;

    fn pack(&mut self, _: &Device, tx: &mut [u8]) -> Result<usize, Self::Error> {
        crate::firmware::operation::write_to_tx(
            tx,
            SilencerFixedUpdateRate {
                tag: TypeTag::Silencer,
                flag: SilencerControlFlags::FIXED_UPDATE_RATE,
                value_intensity: self.intensity.get(),
                value_phase: self.phase.get(),
            },
        );

        self.is_done = true;
        Ok(std::mem::size_of::<SilencerFixedUpdateRate>())
    }

    fn required_size(&self, _: &Device) -> usize {
        std::mem::size_of::<SilencerFixedUpdateRate>()
    }

    fn is_done(&self) -> bool {
        self.is_done
    }
}

impl OperationGenerator<'_> for FixedUpdateRate {
    type O1 = FixedUpdateRateOp;
    type O2 = NullOp;

    fn generate(&mut self, _: &Device) -> Option<(Self::O1, Self::O2)> {
        Some((Self::O1::new(self.intensity, self.phase), Self::O2 {}))
    }
}

#[cfg(test)]
mod tests {
    use std::mem::size_of;

    use super::*;

    #[test]
    fn test() {
        let device = crate::tests::create_device();

        let mut tx = [0x00u8; size_of::<SilencerFixedUpdateRate>()];

        let mut op = FixedUpdateRateOp::new(
            NonZeroU16::new(0x1234).unwrap(),
            NonZeroU16::new(0x5678).unwrap(),
        );

        assert_eq!(
            op.required_size(&device),
            size_of::<SilencerFixedUpdateRate>()
        );
        assert!(!op.is_done());

        assert!(op.pack(&device, &mut tx).is_ok());

        assert!(op.is_done());

        assert_eq!(tx[0], TypeTag::Silencer as u8);
        assert_eq!(tx[1], SilencerControlFlags::FIXED_UPDATE_RATE.0);
        assert_eq!(tx[2], 0x34);
        assert_eq!(tx[3], 0x12);
        assert_eq!(tx[4], 0x78);
        assert_eq!(tx[5], 0x56);
    }
}