Skip to main content

FunctionId

Struct FunctionId 

Source
pub struct FunctionId(pub u8);
Expand description

A Serial API function id.

Tuple Fields§

§0: u8

Implementations§

Source§

impl FunctionId

Source

pub const GET_INIT_DATA: FunctionId

Serial API init data: API version, capabilities, node list, chip.

Source

pub const SET_APPLICATION_NODE_INFO: FunctionId

Sets the node information frame the controller sends.

Source

pub const APPLICATION_COMMAND_HANDLER: FunctionId

A command class frame received from a node.

Source

pub const GET_CONTROLLER_CAPABILITIES: FunctionId

Controller role flags (primary, SIS, SUC).

Source

pub const SET_SERIAL_API_TIMEOUTS: FunctionId

Serial API ACK and byte timeouts.

Source

pub const GET_SERIAL_API_CAPABILITIES: FunctionId

Firmware version, manufacturer, product and supported functions.

Source

pub const SOFT_RESET: FunctionId

Restarts the controller firmware.

Source

pub const GET_PROTOCOL_VERSION: FunctionId

Z-Wave protocol version.

Source

pub const SERIAL_API_STARTED: FunctionId

Sent by the controller after it starts.

Source

pub const SERIAL_API_SETUP: FunctionId

Serial API setup subcommands (TX status report, region, power).

Source

pub const SEND_NODE_INFORMATION: FunctionId

Broadcasts or sends the controller’s node information frame.

Source

pub const SEND_DATA: FunctionId

Sends a command class frame to a node.

Source

pub const SEND_DATA_MULTICAST: FunctionId

Sends a command class frame to several nodes.

Source

pub const GET_CONTROLLER_VERSION: FunctionId

Library version string and library type.

Source

pub const SEND_DATA_ABORT: FunctionId

Aborts the SendData in progress.

Source

pub const GET_RANDOM: FunctionId

Random bytes from the chip.

Source

pub const GET_CONTROLLER_ID: FunctionId

Home id and own node id.

Source

pub const GET_NVM_ID: FunctionId

External NVM manufacturer, type and size (500 series).

Source

pub const EXT_NVM_READ_LONG_BUFFER: FunctionId

Reads from the external NVM (500 series).

Source

pub const NVM_OPERATIONS: FunctionId

NVM backup and restore (700 and 800 series, 16-bit offsets).

Source

pub const GET_BACKGROUND_RSSI: FunctionId

Background noise per channel.

Source

pub const EXTENDED_NVM_OPERATIONS: FunctionId

NVM backup and restore (32-bit offsets).

Source

pub const REMOVE_NODE_ID_FROM_NETWORK: FunctionId

Removes a specific node id (exclusion).

Source

pub const GET_NODE_PROTOCOL_INFO: FunctionId

Listening, routing, security and device class of a node.

Source

pub const SET_DEFAULT: FunctionId

Resets the controller to factory defaults (new home id).

Source

pub const ASSIGN_RETURN_ROUTE: FunctionId

Assigns a return route from a node to another.

Source

pub const DELETE_RETURN_ROUTE: FunctionId

Deletes a node’s return routes.

Source

pub const REQUEST_NODE_NEIGHBOR_UPDATE: FunctionId

Asks a node to rediscover its neighbors.

Source

pub const APPLICATION_UPDATE: FunctionId

Node information and SmartStart events.

Source

pub const ADD_NODE_TO_NETWORK: FunctionId

Inclusion.

Source

pub const REMOVE_NODE_FROM_NETWORK: FunctionId

Exclusion.

Source

pub const ASSIGN_SUC_RETURN_ROUTE: FunctionId

Assigns a return route to the SUC.

Source

pub const SET_SUC_NODE_ID: FunctionId

Makes a node the SUC/SIS.

Source

pub const GET_SUC_NODE_ID: FunctionId

The SUC’s node id.

Source

pub const REQUEST_NODE_INFO: FunctionId

Asks a node for its node information frame.

Source

pub const REMOVE_FAILED_NODE: FunctionId

Removes a node that no longer responds.

Source

pub const IS_FAILED_NODE: FunctionId

Whether the controller considers a node failed.

Source

pub const REPLACE_FAILED_NODE: FunctionId

Includes a new node in a failed node’s id.

Source

pub const GET_ROUTING_INFO: FunctionId

A node’s neighbor table.

Source

pub const GET_PRIORITY_ROUTE: FunctionId

A node’s priority route.

Source

pub const SET_PRIORITY_ROUTE: FunctionId

Sets a node’s priority route.

Source

pub const BRIDGE_APPLICATION_COMMAND_HANDLER: FunctionId

A command class frame received, bridge format.

Source

pub const SEND_DATA_BRIDGE: FunctionId

SendData from a virtual node.

Source

pub const GET_LONG_RANGE_NODES: FunctionId

Long Range node list.

Source

pub const GET_LONG_RANGE_CHANNEL: FunctionId

Long Range channel.

Source

pub const SET_LONG_RANGE_CHANNEL: FunctionId

Sets the Long Range channel.

Source

pub fn name(self) -> &'static str

The function’s name, for logs.

Trait Implementations§

Source§

impl Clone for FunctionId

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FunctionId

Source§

impl Debug for FunctionId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for FunctionId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FunctionId

Source§

impl From<FunctionId> for u8

Source§

fn from(f: FunctionId) -> u8

Converts to this type from the input type.
Source§

impl Hash for FunctionId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for FunctionId

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for FunctionId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for FunctionId

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for FunctionId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more