Properties

properties

SystemInfo

Bases: BaseModel

System information.

name class-attribute instance-attribute

name = Field(default=None, description='System name.')

version class-attribute instance-attribute

version = Field(default=None, description="System version.")

kernel class-attribute instance-attribute

kernel = Field(default=None, description='Kernel version.')

hostname class-attribute instance-attribute

hostname = Field(default=None, description='Hostname.')

arch class-attribute instance-attribute

arch = Field(default=None, description='Architecture.')

memory class-attribute instance-attribute

memory = Field(description='Memory information.')

networks class-attribute instance-attribute

networks = Field(description='Network information.')

disks class-attribute instance-attribute

disks = Field(description='Disk information.')

exports class-attribute instance-attribute

exports = Field(
    default=None, description="Exported services."
)

rugix class-attribute instance-attribute

rugix = Field(
    default=None,
    description="Rugix-specific system information.",
)

yocto class-attribute instance-attribute

yocto = Field(
    default=None,
    description="Yocto-specific system information.",
)

MemoryInfo

Bases: BaseModel

Memory information.

total class-attribute instance-attribute

total = Field(description='Total memory in bytes.')

NetworkInterfaceInfo

Bases: BaseModel

Network interface information.

name class-attribute instance-attribute

name = Field(description='Name of the network interface.')

mac_address class-attribute instance-attribute

mac_address = Field(
    description="MAC address of the network interface.",
    validation_alias="macAddress",
    serialization_alias="macAddress",
)

ip_addresses class-attribute instance-attribute

ip_addresses = Field(
    description="IP addresses of the network interface.",
    validation_alias="ipAddresses",
    serialization_alias="ipAddresses",
)

DiskInfo

Bases: BaseModel

Disk information.

name class-attribute instance-attribute

name = Field(description='Name of the disk.')

filesystem class-attribute instance-attribute

filesystem = Field(description='Filesystem type.')

mount_point class-attribute instance-attribute

mount_point = Field(
    description="Mount point.",
    validation_alias="mountPoint",
    serialization_alias="mountPoint",
)

total_space class-attribute instance-attribute

total_space = Field(
    description="Total disk space in bytes.",
    validation_alias="totalSpace",
    serialization_alias="totalSpace",
)

available_space class-attribute instance-attribute

available_space = Field(
    description="Available disk space in bytes.",
    validation_alias="availableSpace",
    serialization_alias="availableSpace",
)

OtaUpdateStatus

Bases: BaseModel

OTA update status (dev.nexigon.ota.status).

Published by the device agent to report the effective OTA configuration and the current state of the update process.

config class-attribute instance-attribute

config = Field(
    default=None,
    description="Effective OTA configuration (TOML defaults merged with device overrides).",
)

current_version class-attribute instance-attribute

current_version = Field(
    default=None,
    description="Currently installed version (matches a repository version tag).",
    validation_alias="currentVersion",
    serialization_alias="currentVersion",
)

state class-attribute instance-attribute

state = Field(
    default=None,
    description="Current state of the update process.",
)

target_version class-attribute instance-attribute

target_version = Field(
    default=None,
    description="Target version being installed, if an update is in progress.",
    validation_alias="targetVersion",
    serialization_alias="targetVersion",
)

failure_count class-attribute instance-attribute

failure_count = Field(
    default=None,
    description="Number of consecutive failed update attempts for the current target.\nReset to zero when the config changes or an update succeeds.",
    validation_alias="failureCount",
    serialization_alias="failureCount",
)

last_error class-attribute instance-attribute

last_error = Field(
    default=None,
    description="Error message from the last failed attempt, if any.",
    validation_alias="lastError",
    serialization_alias="lastError",
)

OtaUpdateConfig

Bases: BaseModel

OTA update configuration identifying the update source.

Used as the shape of /etc/nexigon-rugix-ota.json and the dev.nexigon.ota.config device property. The device property is merged on top of the file-based defaults.

path class-attribute instance-attribute

path = Field(
    default=None,
    description="Repository path prefix for locating update artifacts.",
)

DeviceHealth

Bases: BaseModel

Device health information (dev.nexigon.system.health).

status class-attribute instance-attribute

status = Field(description='Health status of the device.')

HttpExportInfo

Bases: BaseModel

HTTP export information.

name class-attribute instance-attribute

name = Field(description='Name of the export.')

port class-attribute instance-attribute

port = Field(description='Port the service listens on.')

path class-attribute instance-attribute

path = Field(default=None, description='URL path prefix.')

RugixSystemInfo

Bases: BaseModel

Rugix-specific system information.

slots class-attribute instance-attribute

slots = Field(
    description="Information about the update slots."
)

boot class-attribute instance-attribute

boot = Field(
    default=None,
    description="Rugix-specific boot information.",
)

state class-attribute instance-attribute

state = Field(
    description="Information about the state management mechanism."
)

build class-attribute instance-attribute

build = Field(
    default=None,
    description="Rugix Bakery build information (only when built with Rugix Bakery).",
)

RugixSlotInfo

Bases: BaseModel

Information about a Rugix update slot.

active class-attribute instance-attribute

active = Field(
    default=None,
    description="Indicates whether the slot is active, i.e., in use.",
)

hashes class-attribute instance-attribute

hashes = Field(
    default=None,
    description="Hashes of the slot data according to the slot database.",
)

size class-attribute instance-attribute

size = Field(
    default=None,
    description="Size of the slot data according to the slot database.",
)

updated_at class-attribute instance-attribute

updated_at = Field(
    default=None,
    description="Last time the slot has been updated according to the slot database.",
    validation_alias="updatedAt",
    serialization_alias="updatedAt",
)

RugixBootInfo

Bases: BaseModel

Rugix-specific boot information.

boot_flow class-attribute instance-attribute

boot_flow = Field(
    description="Name of the boot flow.",
    validation_alias="bootFlow",
    serialization_alias="bootFlow",
)

active_group class-attribute instance-attribute

active_group = Field(
    default=None,
    description="Active boot group.",
    validation_alias="activeGroup",
    serialization_alias="activeGroup",
)

default_group class-attribute instance-attribute

default_group = Field(
    default=None,
    description="Default boot group.",
    validation_alias="defaultGroup",
    serialization_alias="defaultGroup",
)

groups class-attribute instance-attribute

groups = Field(
    description="Information about the boot groups."
)

RugixBootGroupInfo

Bases: BaseModel

Information about a Rugix boot group.

RugixActiveStateManagementInfo

Bases: BaseModel

Information about the state management mechanism, if state management is active.

data_partition class-attribute instance-attribute

data_partition = Field(
    default=None,
    description="Device backing the data partition, if any.",
    validation_alias="dataPartition",
    serialization_alias="dataPartition",
)

RugixBakeryBuildInfo

Bases: BaseModel

Rugix Bakery build information.

name class-attribute instance-attribute

name = Field(description='System name.')

release class-attribute instance-attribute

release = Field(
    description="Rugix Bakery build release information."
)

RugixBakeryReleaseInfo

Bases: BaseModel

Rugix Bakery build release information.

id class-attribute instance-attribute

id = Field(description='Release ID.')

version class-attribute instance-attribute

version = Field(description='Release version.')

YoctoSystemInfo

Bases: BaseModel

Yocto-specific system information.

build_info class-attribute instance-attribute

build_info = Field(
    description="Build information key-value pairs read from `/etc/buildinfo`.",
    validation_alias="buildInfo",
    serialization_alias="buildInfo",
)

DeviceCommandManifest

Bases: BaseModel

Command manifest (dev.nexigon.commands property).

commands class-attribute instance-attribute

commands = Field(description='Available commands.')

DeviceCommandDescriptor

Bases: BaseModel

Descriptor for an on-demand command.

name class-attribute instance-attribute

name = Field(description='Command name.')

description class-attribute instance-attribute

description = Field(
    default=None,
    description="Description of what the command does.",
)

category class-attribute instance-attribute

category = Field(
    default=None,
    description="Category for grouping in the UI.",
)

input class-attribute instance-attribute

input = Field(
    default=None,
    description="JSON Schema for the command input.",
)

output class-attribute instance-attribute

output = Field(
    default=None,
    description="JSON Schema for the command output.",
)

OtaUpdateState_Idle

Bases: RootModel[Literal['idle']]

OtaUpdateState_Installing

Bases: RootModel[Literal['installing']]

OtaUpdateState_Rebooting

Bases: RootModel[Literal['rebooting']]

OtaUpdateState_Committing

Bases: RootModel[Literal['committing']]

OtaUpdateState_Completed

Bases: RootModel[Literal['completed']]

OtaUpdateState_Failed

Bases: RootModel[Literal['failed']]

OtaUpdateState_Blocked

Bases: RootModel[Literal['blocked']]

OtaUpdateState_Rollback

Bases: RootModel[Literal['rollback']]

OtaUpdateState

OtaUpdateState = (
    OtaUpdateState_Idle
    | OtaUpdateState_Installing
    | OtaUpdateState_Rebooting
    | OtaUpdateState_Committing
    | OtaUpdateState_Completed
    | OtaUpdateState_Failed
    | OtaUpdateState_Blocked
    | OtaUpdateState_Rollback
)

DeviceHealthStatus_Healthy

Bases: RootModel[Literal['healthy']]

DeviceHealthStatus_Degraded

Bases: RootModel[Literal['degraded']]

DeviceHealthStatus_Error

Bases: RootModel[Literal['error']]

DeviceHealthStatus

DeviceHealthStatus = (
    DeviceHealthStatus_Healthy
    | DeviceHealthStatus_Degraded
    | DeviceHealthStatus_Error
)

ExportInfo_Http

Bases: HttpExportInfo

protocol class-attribute instance-attribute

protocol = 'http'

ExportInfo

ExportInfo = ExportInfo_Http

RugixStateManagementInfo_Disabled

Bases: BaseModel

status class-attribute instance-attribute

status = 'Disabled'

RugixStateManagementInfo_Active

Bases: RugixActiveStateManagementInfo

status class-attribute instance-attribute

status = 'Active'

RugixStateManagementInfo_Error

Bases: BaseModel

status class-attribute instance-attribute

status = 'Error'

RugixStateManagementInfo

RugixStateManagementInfo = Annotated[
    RugixStateManagementInfo_Disabled
    | RugixStateManagementInfo_Active
    | RugixStateManagementInfo_Error,
    Discriminator("status"),
]