Enum ControlCommand 

pub enum ControlCommand {
    Scan {
        code: String,
        terminator: Option<Terminator>,
        delay_ms: Option<u64>,
    },
    Tap {
        uid: String,
        records: Option<Vec<NdefRecord>>,
    },
    NfcWrite {
        records: Vec<NdefRecord>,
        overwrite: bool,
    },
    NfcMakeReadOnly,
    CloseDrawer,
    Custom {
        name: String,
        payload: Value,
    },
}

A control action sent to a device: by a person, test or agent (scan, tap, close drawer), or by the app through a browser API that does not carry bytes (an NFC write).

use hardless_core::ControlCommand;
let cmd: ControlCommand =
    serde_json::from_str(r#"{ "type": "scan", "code": "4006381333931" }"#).unwrap();
assert!(matches!(cmd, ControlCommand::Scan { .. }));

Variants

Scan

Scan a barcode (POST /devices/:id/scan).

Fields

code: String

The barcode content.

terminator: Option<Terminator>

Overrides the device’s terminator.

delay_ms: Option<u64>

Overrides the device’s inter-key delay.

Tap

Tap an NFC card (POST /devices/:id/tap).

Fields

uid: String

Card UID as hex, e.g. 04a2b3c4d5e6f7.

records: Option<Vec<NdefRecord>>

The card’s NDEF records. Without them the reader uses what it remembers of this card (including anything the app wrote to it), or an empty card.

NfcWrite

The app writes records to the card on the reader (NDEFReader.write()).

Fields

records: Vec<NdefRecord>

The records to write.

overwrite: bool

Whether existing data may be replaced (Web NFC’s overwrite, default true).

NfcMakeReadOnly

The app makes the card on the reader read-only (NDEFReader.makeReadOnly()).

CloseDrawer

Close an open cash drawer by hand.

Custom

A device-specific command for plugins.

Fields

name: String

Command name.

payload: Value

Command arguments.

Trait Implementations

impl Clone for ControlCommand

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ControlCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ControlCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ControlCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ControlCommand