Motion Master 6.0.0-alpha.86
Next-generation motion control software
Loading...
Searching...
No Matches
mm::node::FullFirmwareDescriptors Struct Reference

The full firmware descriptors one device accepts firmware under (specification §3.4.1). More...

#include <firmware_package.h>

Collaboration diagram for mm::node::FullFirmwareDescriptors:
[legend]

Public Attributes

std::optional< std::string > assembly
 
std::string device
 

Detailed Description

The full firmware descriptors one device accepts firmware under (specification §3.4.1).

Two rather than one, because the specification says both are compatible and lists both for the user to choose from (§4.1 step 5). The distinction is worth keeping: assembly firmware "should have been customized for the assembly", so it is the one to prefer, while the device package is the generic build for the hardware inside it.

Member Data Documentation

◆ assembly

std::optional<std::string> mm::node::FullFirmwareDescriptors::assembly

The assembly's build descriptor with the device's key id, e.g. "6000-01-2423-1". Nothing when the hardware description carries no assembly. Assemblies have no key of their own — §3.4.1 is explicit that the descriptor "must pull the ID and version from the assembly, the keyId from the device".

◆ device

std::string mm::node::FullFirmwareDescriptors::device

The device's own descriptor, e.g. "9010-02-2423-1". Always present: a hardware description always describes a device.


The documentation for this struct was generated from the following file: