io.veea.VeeaHub.Info¶

Name¶

io.veea.VeeaHub.Info

Methods¶

CODE

HardwareType            (OUT s                     hardware_type);
HardwarePcba            (OUT s                     hardware_pcba);
HardwareRevision        (OUT s                     hardware_revision);
Model                   (OUT s                     model);
BoardType               (OUT s                     board_type);
CpuTemperature          (OUT i                     cpu_temperature);
CellularDriverVersion   (OUT s                     cellular_driver_version);
ManufacturerSerial      (OUT s                     manufacturer_serial);
SocSerial               (OUT s                     soc_serial);
VeeaSerial              (OUT s                     veea_serial);
BatteryIsGood           (OUT (ib)                  battery_is_good);
LastRebootTime          (OUT (is)                  last_reboot_time);
LastRecoveryTime        (OUT (is)                  last_recovery_time);
ActiveSystem            (OUT s                     active_system_uuid);
Hostname                (OUT s                     hostname);
OSVersion               (OUT s                     OSVersion);
PlatformSoftware        (OUT a(issssis)            platform_software_list);
SoftwareVersion         (OUT s                     software_version);
StorageCapacity         (OUT a{s(sssssss)}         file_system_list);
Memory                  (OUT a{ss}                 meminfo);
LoadAvg                 (OUT (ssssss)              load_avg);
Cpu                     (OUT (atatatatatattiiiiai) cpu_info);
ProductFeatures         (OUT a{ss}                 product_features_info);
ProductSerial           (OUT (sssssssssss)         product_serial_info);
SerialNumberDecode      (OUT a{sv}                 info);
BootCount               (OUT i                     boot_count);
BootCrc                 (OUT u                     boot_crc);
BootMagic               (OUT u                     boot_magic);
LastBootCount           (OUT i                     last_boot_count);
LastResetReason         (OUT (is)                  last_reset_reason);
LastSystemState         (OUT (is)                  last_system_state);
RequestSystem           (OUT (is)                  request_system);
ResetReason             (OUT (is)                  reset_reason);
RunningSystem           (OUT (is)                  running_system);
SystemState             (OUT (is)                  system_state);
HardwareModuleInventory (OUT a(sssss)              hardware_module_inventory_list);
HardwareInventoryDetail (OUT (ia{sv})              hardware_inventory_detail_report);
NodeType                (OUT s                     node_type);
NodeCountry             (OUT s                     node_country);
MeshUUID                (OUT s                     MeshUUID);
BaseMACAddress          (OUT s                     board_mac_address);
MACAddressNumber        (OUT i                     board_mac_address_number);
OwnerUUID               (OUT s                     OwnerUUID);

Description¶

This interface allows the client to retrieve VeeaHub information.

Method Details¶

The HardwareType() method¶

CODE

HardwareType (OUT s hardware_type);

Returns the hardware type as a string.

Allow: context=default

OUT s hardware_type:

The hardware type

The HardwarePcba() method¶

CODE

HardwarePcba (OUT s hardware_pcba);

Returns the hardware PCBA as a string.

Allow: context=default

OUT s hardware_pcba:

The hardware PCBA

The HardwareRevision() method¶

CODE

HardwareRevision (OUT s hardware_revision);

Returns the hardware revision as a string.

Allow: context=default

OUT s hardware_revision:

The hardware revision

The Model() method¶

CODE

Model (OUT s model);

Returns the hardware model as a string.

Allow: context=default

OUT s model:

The hardware model

The BoardType() method¶

CODE

BoardType (OUT s board_type);

Returns the hardware board type as a string.

Allow: context=default

OUT s board_type:

The hardware board type

The CpuTemperature() method¶

CODE

CpuTemperature (OUT i cpu_temperature);

Returns the CPU temperature in milli degrees Celsius.

Allow: context=default

OUT i cpu_temperature:

The CPU temperature in milli degrees Celsius

The CellularDriverVersion() method¶

CODE

CellularDriverVersion (OUT s cellular_driver_version);

Returns the contents of the cellular driver module version file.

Allow: context=default

OUT s cellular_driver_version:

The name and version of the Cellular driver

The ManufacturerSerial() method¶

CODE

ManufacturerSerial (OUT s manufacturer_serial);

Returns the manufacturer serial number for the main system board as a string.

Allow: context=default

OUT s manufacturer_serial:

The manufacturer serial number as a string

The SocSerial() method¶

CODE

SocSerial (OUT s soc_serial);

Returns the system-on-chip serial number as a string.

Allow: context=default

OUT s soc_serial:

The SOC serial number as a string

The VeeaSerial() method¶

CODE

VeeaSerial (OUT s veea_serial);

Returns the Veea-issued serial number for the main system board as a string.

Allow: context=default

OUT s veea_serial:

The Veea-issued serial number as a string

The BatteryIsGood() method¶

CODE

BatteryIsGood (OUT (ib) battery_is_good);

DEPRECATED - rely on platform LEDs to show battery state

battery_is_good: The battery status The first return value is 0 if the status was read successfully and 1 for failure The second return value is only defined if the first return value is 0. It will be true if the battery is ok and false if it is bad.

Allow: context=default

OUT (ib) battery_is_good:

The LastRebootTime() method¶

CODE

LastRebootTime (OUT (is) last_reboot_time);

The first return value is the number of seconds since the epoch if the time was read successfully and 0 for failure The second return value is only defined if the first return value is not 0. It indicates the last reboot time as a string.

Allow: context=default

OUT (is) last_reboot_time:

The last reboot time

The LastRecoveryTime() method¶

CODE

LastRecoveryTime (OUT (is) last_recovery_time);

The first return value is the number of seconds since the epoch if the time was read successfully and 0 for failure The second return value is only defined if the first return value is not 0. It indicates the last recovery time as a string.

Allow: context=default

OUT (is) last_recovery_time:

The last recovery time

The ActiveSystem() method¶

CODE

ActiveSystem (OUT s active_system_uuid);

Returns the value is the partition UUID of the active/running system as a string.

Allow: context=default

OUT s active_system_uuid:

The running system partition UUID

The Hostname() method¶

CODE

Hostname (OUT s hostname);

Returns the systems hostname as a string.

Allow: context=default

OUT s hostname:

The host name

The OSVersion() method¶

CODE

OSVersion (OUT s OSVersion);

Returns the OS version as a string.

Allow: context=default

OUT s OSVersion:

The OS Version

The PlatformSoftware() method¶

CODE

PlatformSoftware (OUT a(issssis) platform_software_list);

Returns a list of platform software meta-data for each info partition.

Allow: context=default

OUT a(issssis) platform_software_list:

The list of platform software meta-data

The SoftwareVersion() method¶

CODE

SoftwareVersion (OUT s software_version);

Returns the software version as a string.

Allow: context=default

OUT s software_version:

The software version

The StorageCapacity() method¶

CODE

StorageCapacity (OUT a{s(sssssss)} file_system_list);

Returns a list of file system node and size information.

Allow: context=default

OUT a{s(sssssss)} file_system_list:

The list of file system node and size info

The Memory() method¶

CODE

Memory (OUT a{ss} meminfo);

Returns a dictionary of all items from /proc/meminfo.

See the meminfo specification for description of all items returned in /proc/meminfo

Allow: context=default

OUT a{ss} meminfo:

The dictionary of memory info

The LoadAvg() method¶

CODE

LoadAvg (OUT (ssssss) load_avg);

Returns all items from /proc/loadavg.

See the loadavg specification for description of all items returned in /proc/loadavg

Allow: context=default

OUT (ssssss) load_avg:

Load average

The Cpu() method¶

CODE

Cpu (OUT (atatatatatattiiiiai) cpu_info);

Returns all info from /proc/stat

See the stat specification for description of all items returned in /proc/loadavg

Allow: context=default

OUT (atatatatatattiiiiai) cpu_info:

Stat info

The ProductFeatures() method¶

CODE

ProductFeatures (OUT a{ss} product_features_info);

Returns a dictionary of platform specific information with the following fields:

ProductFeatures is intended to describe features that cannot reliably be determined through software means e.g. by scanning a USB bus, or device-tree look-up.

Product Features might include:

Manufacturing considerations e.g. to describe when erratas or waivers are imposed Physical consideration e.g. if a high-gain antenna fitted

Allow: context=default

OUT a{ss} product_features_info:

Product feature info

The ProductSerial() method¶

CODE

ProductSerial (OUT (sssssssssss) product_serial_info);

DEPRECATED - superseded by SerialNumberDecode

Decodes product serial number and returns the following values:

These values above are encoded into a VeeaHub serial number and the encoding definition is documented in the serial number specification.

Allow: context=default

OUT (sssssssssss) product_serial_info:

Product serial info

Warning¶

The ProductSerial() method is deprecated.

The SerialNumberDecode() method¶

CODE

SerialNumberDecode (OUT a{sv} info);

Decodes the product serial number and returns a dictionary with the following values:

These values above are encoded into a VeeaHub serial number and the encoding definition is documented in the serial number specification.

Allow: context=default

OUT a{sv} info:

Product serial info decoded as a dictionary

The BootCount() method¶

CODE

BootCount (OUT i boot_count);

Set to zero when the unit is powered up and incremented by one by first stage bootloader (U-Boot, TBL1FW/NBL1FW) every time it boots or reboots.

If the boot count is over 12, the bootloader resets it back to 7. Thus, once in self-heal, it will alternate between the self-heal primary and self-heal backup.

Defines first stage bootloader default boot selection: 0-3 = preferred system, 4-6 = failover system, 7-9 = self-heal primary, 10-12 = self-heal backup.

Reset to zero by the system after successful self-heal or upon controlled system reboot.

Allow: context=default

OUT i boot_count:

The boot count

The BootCrc() method¶

CODE

BootCrc (OUT u boot_crc);

Returns the CRC used to check the integrity of data backed in DRAM.

Allow: context=default

OUT u boot_crc:

The boot CRC

The BootMagic() method¶

CODE

BootMagic (OUT u boot_magic);

Returns a number used for memory mapped platforms to indicate that the boot info has been initialized and is valid.

Allow: context=default

OUT u boot_magic:

The boot magic value

The LastBootCount() method¶

CODE

LastBootCount (OUT i last_boot_count);

Returns a copy of boot_count when first stage bootloader started.

Allow: context=default

OUT i last_boot_count:

The last boot count

The LastResetReason() method¶

CODE

LastResetReason (OUT (is) last_reset_reason);

Returns the reason (value and name) for the last reset. See [ResetReason() for return value details.

Allow: context=default

OUT (is) last_reset_reason:

The last reset reason

The LastSystemState() method¶

CODE

LastSystemState (OUT (is) last_system_state);

Returns a copy of the system state (value and name) when first stage bootloader started. See SystemState() for return value details.

Allow: context=default

OUT (is) last_system_state:

The last system state

The RequestSystem() method¶

CODE

RequestSystem (OUT (is) request_system);

Returns the value and name of the most recent explicit boot request for first stage boot loaded on next boot.

Allow: context=default

OUT (is) request_system:

The most recent boot request

The ResetReason() method¶

CODE

ResetReason (OUT (is) reset_reason);

Returns the reason (value and name) of the next reset.

Allow: context=default

OUT (is) reset_reason:

The reset reason

The RunningSystem() method¶

CODE

RunningSystem (OUT (is) running_system);

Returns the value and name of the running system..

Allow: context=default

OUT (is) running_system:

The running system

The SystemState() method¶

CODE

SystemState (OUT (is) system_state);

Returns the system state (value and name) which is used for tracking to detect failed boot or provide additional information about what the system was doing when the reboot occurred.

Allow: context=default

OUT (is) system_state:

The system state

The HardwareModuleInventory() method¶

CODE

HardwareModuleInventory (OUT a(sssss) hardware_module_inventory_list);

Returns a list of the currently supported and attached USB and PCI hardware in the following format:

Allow: context=default

OUT a(sssss) hardware_module_inventory_list:

The list of hardware

The HardwareInventoryDetail() method¶

CODE

HardwareInventoryDetail (OUT (ia{sv}) hardware_inventory_detail_report);

hardware_inventory_detail: Returns both a return code and an array of dictionaries that contain the Hardware Inventory Detail Report. This is a dynamic report that contains all hardware modules currently present at the time this report is run regardless of what hardware was present during manufacturing. The output structure is very similar to the VeeaHub Manufacturing Report. The detailed manufacturing-report format is not included in this repository.

Allow: context=default

OUT (ia{sv}) hardware_inventory_detail_report:

The NodeType() method¶

CODE

NodeType (OUT s node_type);

Returns the node type in the form "MEN" or "MN". If the database is available, then this setting will be read directly. If the database is not available, then this setting will be read from the enrolment data (if available), otherwise the default will be "MEN".

Allow: context=default

OUT s node_type:

The node type

The NodeCountry() method¶

CODE

NodeCountry (OUT s node_country);

Returns the node country as a ⅔ letter country code (ISO 3166). The country code is set by enrolment, and cannot be changed except by re-enrolling the unit.

Allow: context=default

OUT s node_country:

The MeshUUID() method¶

CODE

MeshUUID (OUT s MeshUUID);

Returns the current mesh UUID, as set by enrolment.

Allow: context=default

OUT s MeshUUID:

The current mesh UUID

The BaseMACAddress() method¶

CODE

BaseMACAddress (OUT s board_mac_address);

Returns the base MAC address as a string.

Allow: context=default

OUT s board_mac_address:

The base address of the 32-address block allocated to this VeeaHub

The MACAddressNumber() method¶

CODE

MACAddressNumber (OUT i board_mac_address_number);

Returns the number of MAC addresses.

Allow: context=default

OUT i board_mac_address_number:

The number of MAC addresses allocated to this VeeaHub.

The OwnerUUID() method¶

CODE

OwnerUUID (OUT s OwnerUUID);

Returns the current owner UUID, as set by enrolment.

Allow: context=default

OUT s OwnerUUID:

The current owner UUID