DeviceConfig

class DeviceType

Device type

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DeviceType

Parameters

device_type (DeviceTypes) – Device type

class RunMode

Run mode

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.RunMode

Parameters

run_mode (RunModes) – Run mode

class FirmwareVersion

Firmware version for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.FirmwareVersion

Parameters

firmware_version (int) – Firmware version

class BootloaderVersion

Bootloader version for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.BootloaderVersion

Parameters

bootloader_version (int) – Bootloader version

class ModelNumber

Model number for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.ModelNumber

Parameters

model_number (str) – Model number of size 25 including null character

class PartNumber

Part number for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.PartNumber

Parameters

part_number (str) – Part number of size 25 including null character

class SerialNumber

Serial number for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.SerialNumber

Parameters

serial_number (str) – Serial number of size 25 including null character

class MACAddress

MAC address for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.MACAddress

Parameters

mac_address (bytes) – MAC address

class IPv4Settings

IPv4 settings for the device, including address, subnet mask, and default gateway

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.IPv4Settings

Parameters

  • ipv4_address (int) – IPv4Address

  • ipv4_subnet_mask (int) – IPv4SubnetMask

  • ipv4_default_gateway (int) – IPv4DefaultGateway

class PartNumberRevision

Part number revision for the device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.PartNumberRevision

Parameters

part_number_revision (str) – Part number revision

class RebootRqst

Reboot request with bootloader delay

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.RebootRqst

Parameters

delay (int) – Bootloader delay

class DiagnosticBank

Message to specify a diagnostic bank

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticBank

Parameters

bank (DiagnosticBank) –

class DiagnosticInformation

Information about a specific diagnostic

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticInformation

Parameters

  • handle (DiagnosticHandle) – Diagnostic handle that this information is about

  • can_change_diagnostic_state (bool) – True if related diagnostic configuration can be modified

  • has_warning_threshold (bool) – True if diagnostic status can go in Warning

  • has_error_threshold (bool) – True if diagnostic status can go in Error

  • limit_type (DiagnosticLimitType) – Diagnostic limit type

  • default_warning_threshold (float) – Default warning threshold (if ‘limit_type’ is either MINIMAL_LIMIT or MAXIMAL_LIMIT and ‘has_warning_threshold’ is true)

  • default_error_threshold (float) – Default error threshold (if ‘limit_type’ is either MINIMAL_LIMIT or MAXIMAL_LIMIT and ‘has_error_threshold’ is true)

  • upper_hard_limit (float) – Maximal threshold value (if ‘limit_type’ is either MINIMAL_LIMIT or MAXIMAL_LIMIT)

  • lower_hard_limit (float) – Minimal threshold value (if ‘limit_type’ is either MINIMAL_LIMIT or MAXIMAL_LIMIT)

  • status (DiagnosticStatusValue) – Current diagnostic status

  • unit (Unit) – Unit that the diagnostic status is in

class DiagnosticInformationList

Array of diagnostic information

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticInformationList

Parameters

information (DiagnosticInformation [ ]) –

class DiagnosticEnable

Enable or disable a specific diagnostic

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticEnable

Parameters

  • handle (DiagnosticHandle) – Handle to diagnostic to enable or disable

  • enable (bool) – Diagnostic enable state

class DiagnosticThreshold

Configure threshold of a specific diagnostic

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticThreshold

Parameters

  • handle (DiagnosticHandle) – Identifies diagnostic to configure

  • value (float) – Diagnostic threshold value

class DiagnosticConfiguration

Configuration for a diagnostic

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticConfiguration

Parameters

  • handle (DiagnosticHandle) – Handle to diagnostic to configure

  • error_threshold (float) – Diagnostic error threshold value

  • warning_threshold (float) – Diagnostic warning threshold value

  • enable (DiagnosticEnable) – Diagnostic enable state

class DiagnosticConfigurationList

Array of diagnostic configurations

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticConfigurationList

Parameters

configuration (DiagnosticConfiguration [ ]) – Diagnostic configuration

class DiagnosticStatus

Diagnostic status

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.DiagnosticStatus

Parameters

value (DiagnosticStatusValue) – Diagnostic status (e.g. in error, warning or normal state)

class CalibrationParameter

Single calibration parameter information

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.CalibrationParameter

Parameters

  • calibration_parameter_identifier (int) – Calibration parameter identifier

  • signedIntValue (int) – Signed int calibration value.. Part of the value Oneof.

  • unsignedIntValue (int) –

    Unsigned int calibration value.. Part of the value Oneof.

  • floatValue (float) –

    Float calibration value.. Part of the value Oneof.

class Calibration

Calibration information to push to device

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.Calibration

Parameters
class CalibrationElement

Calibration element

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.CalibrationElement

Parameters

calibration_item (CalibrationItem) – Item to get status

class CalibrationResult

Result of a calibration

Canonical

kortex_api.autogen.messages.DeviceConfig_pb2.CalibrationResult

Parameters

  • calibration_status (CalibrationStatus) – Calibration status

  • calibration_details (int) – Additional information (used when status is in fault)