Struct ether_dream::protocol::DacStatus

#[repr(C)]pub struct DacStatus {
    pub protocol: u8,
    pub light_engine_state: u8,
    pub playback_state: u8,
    pub source: u8,
    pub light_engine_flags: u16,
    pub playback_flags: u16,
    pub source_flags: u16,
    pub buffer_fullness: u16,
    pub point_rate: u32,
    pub point_count: u32,
}

Periodically, and as part of ACK packets, the DAC sends its current playback status to the host.

Fields

protocol: u8

This remains undocumented in the protocol.

The original implementation source simply sets this to 0.

light_engine_state: u8

The current state of the "light engine" state machine.

playback_state: u8

The current state of the "playback" state machine.

source: u8

The currently-selected data source:

• 0: Network streaming (the protocol implemented in this library).
• 1: ILDA playback from SD card.
• 2: Internal abstract generator.

light_engine_flags: u16

If the light engine is Ready, this will be 0.

Otherwise, bits will be set as follows:

• 0: Emergency stop occurred due to E-Stop packet or invalid command.
• 1: Emergency stop occurred due to E-Stop input to projector.
• 2: Emergency stop input to projector is currently active.
• 3: Emergency stop occurred due to over-temperature condition.
• 4: Over-temperature condition is currently active.
• 5: Emergency stop occurred due to loss of ethernet link.

All remaining are reserved for future use.

playback_flags: u16

These flags may be non-zero during normal operation.

Bits are defined as follows:

• 0: Shutter state. 0 is closed, 1 is open.
• 1: Underflow. 1 if the last stream ended with underflow rather than a Stop command. This is reset to 0 by the Prepare command.
• 2: E-Stop. 1 if the last stream ended because the E-Stop state was entered. Reset to zero by the Prepare command.

source_flags: u16

This field is undocumented within the protocol reference.

By looking at the source code of the original implementation, this seems to represent the state of the current source.

If source is set to 1 for ILDA playback from SD card, the following flags are defined:

• 0: ILDA_PLAYER_PLAYING.
• 1: ILDA_PLAYER_REPEAT.

If source is set to 2 for the internal abstract generator, the flags are defined as follows:

• 0: ABSTRACT_PLAYING.

buffer_fullness: u16

The number of points currently buffered.

point_rate: u32

If in the Prepared or Playing playback states, this is the number of points per second for which the DAC is configured.

If in the Idle playback state, this will be 0.

point_count: u32

If in the Playing playback state, this is the number of points that the DAC has actually emitted since it started playing.

If in the Prepared or Idle playback states, this will be 0.

Methods

impl DacStatus

pub const LIGHT_ENGINE_READY: u8

The light engine is ready.

pub const LIGHT_ENGINE_WARMUP: u8

In the case where the DAC is also used for thermal control of laser apparatus, this is the state that is entered after power-up.

pub const LIGHT_ENGINE_COOLDOWN: u8

Lasers are off but thermal control is still active.

pub const LIGHT_ENGINE_EMERGENCY_STOP: u8

An emergency stop has been triggered, either by an E-stop input on the DAC, an E-stop command over the network, or a fault such as over-temperature.

pub const PLAYBACK_IDLE: u8

The default state:

• No points may be added to the buffer.
• No output is generated.
• All analog outputs are at 0v.
• The shutter is controlled by the data source.

pub const PLAYBACK_PREPARED: u8

The buffer will accept points.

The output is the same as the Idle state

pub const PLAYBACK_PLAYING: u8

Points are being sent to the output.

pub const SOURCE_NETWORK_STREAMING: u8

Network streaming (the protocol implemented in this library).

pub const SOURCE_ILDA_PLAYBACK_SD: u8

ILDA playback from SD card.

pub const SOURCE_INTERNAL_ABSTRACT_GENERATOR: u8

Internal abstract generator.

Trait Implementations

impl Clone for DacStatus

fn clone(&self) -> DacStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DacStatus

impl Debug for DacStatus

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

Formats the value using the given formatter.

impl Eq for DacStatus

impl Hash for DacStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<DacStatus> for DacStatus

fn eq(&self, other: &DacStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DacStatus) -> bool

This method tests for !=.

impl ReadFromBytes for DacStatus

fn read_from_bytes<R: ReadBytesExt>(reader: R) -> Result<Self>

Read the command from bytes.

impl SizeBytes for DacStatus

const SIZE_BYTES: usize

impl StructuralEq for DacStatus

impl StructuralPartialEq for DacStatus

impl WriteToBytes for DacStatus

fn write_to_bytes<W: WriteBytesExt>(&self, writer: W) -> Result<()>

Write the command to bytes.