Struct NetworkUsers

pub struct NetworkUsers<S, const Y: usize>
where
    S: Default + TreeDeserializeOwned + TreeSerialize + Clone,
{
    pub miniconf: MqttClient<'static, S, NetworkReference, SystemTimer, NamedBroker<NetworkReference>, Y>,
    pub processor: NetworkProcessor,
    pub telemetry: TelemetryClient,
    /* private fields */
}

A structure of Stabilizer’s default network users.

Fields

miniconf: MqttClient<'static, S, NetworkReference, SystemTimer, NamedBroker<NetworkReference>, Y>

processor: NetworkProcessor

telemetry: TelemetryClient

Implementations

impl<S, const Y: usize> NetworkUsers<S, Y>

where S: Default + TreeDeserializeOwned + TreeSerialize + TreeKey + Clone,

pub fn new( stack: NetworkStack, phy: EthernetPhy, clock: SystemTimer, app: &str, net_settings: &NetSettings, metadata: &'static ApplicationMetadata, ) -> Self

Construct Stabilizer’s default network users.

Args

• stack - The network stack that will be used to share with all network users.
• phy - The ethernet PHY connecting the network.
• clock - A SystemTimer implementing Clock.
• app - The name of the application.
• net_settings - The network-specific settings to use for the application.
• metadata - The application metadata

Returns

A new struct of network users.

pub fn configure_streaming(&mut self, format: impl Into<u8>) -> FrameGenerator

Enable data streaming.

Args

• format - A unique u8 code indicating the format of the data.

pub fn direct_stream(&mut self, remote: StreamTarget)

Direct the stream to the provided remote target.

Args

• remote - The destination for the streamed data.

pub fn update(&mut self, settings: &mut S) -> NetworkState

Update and process all of the network users state.

Returns

An indication if any of the network users indicated a state change. The SettingsChanged option contains the path of the settings that changed.