Microhard feature

command messageolympe.messages.microhard.Command.GetState(include_default_capabilities, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Parameters

include_default_capabilities (bool) –

command messageolympe.messages.microhard.Command.PairDevice(network_id, encryption_key, pairing_parameters, connection_parameters, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Parameters

• network_id (string) –

• encryption_key (string) –

• pairing_parameters (olympe.messages.microhard.PairingParameters()) –

• connection_parameters (olympe.messages.microhard.ConnectionParameters()) –

command messageolympe.messages.microhard.Command.PowerOn(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

command messageolympe.messages.microhard.Command.ShutDown(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

event messageolympe.messages.microhard.Event.HardwareError(cause=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Parameters

cause (olympe.enums.microhard.HardwareErrorCause) –

event messageolympe.messages.microhard.Event.Pairing(failure=None, success=None, network_id=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Parameters

• failure (olympe.messages.microhard.PairingStatus.Failure()) –

• success (olympe.messages.microhard.PairingStatus.Success()) –

• network_id (string) –

event messageolympe.messages.microhard.Event.State(default_capabilities=None, offline=None, booting=None, idle=None, pairing=None, connecting=None, connected=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

messageolympe.messages.microhard.Capabilities(channel_min=None, channel_max=None, power_min=None, power_max=None, bandwidths=None, encryption_algorithms=None, _float_tol=(1e-07, 1e-09))

Parameters

• channel_min (u32) –

• channel_max (u32) –

• power_min (u32) –

• power_max (u32) –

• bandwidths (list(olympe.enums.microhard.Bandwidth)) –

• encryption_algorithms (list(olympe.enums.microhard.Encryption)) –

messageolympe.messages.microhard.ConnectionParameters(channel=None, power=None, bandwidth=None, _float_tol=(1e-07, 1e-09))

Parameters

• channel (u32) –

• power (u32) –

• bandwidth (olympe.enums.microhard.Bandwidth) –

messageolympe.messages.microhard.PairingParameters(channel=None, power=None, bandwidth=None, encryption_algorithm=None, _float_tol=(1e-07, 1e-09))

Parameters

• channel (u32) –

• power (u32) –

• bandwidth (olympe.enums.microhard.Bandwidth) –

• encryption_algorithm (olympe.enums.microhard.Encryption) –

messageolympe.messages.microhard.PairingStatus(_float_tol=(1e-07, 1e-09))

messageFailure(reason=None, _float_tol=(1e-07, 1e-09))

Parameters

reason (olympe.enums.microhard.PairingFailureReason) –

messageSuccess(device_uid=None, _float_tol=(1e-07, 1e-09))

Parameters

device_uid (string) –

event messageolympe.messages.microhard.State(default_capabilities=None, offline=None, booting=None, idle=None, pairing=None, connecting=None, connected=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

messageBooting(_float_tol=(1e-07, 1e-09))

messageConnected(device_uid=None, _float_tol=(1e-07, 1e-09))

Parameters

device_uid (string) –

messageConnecting(device_uid=None, _float_tol=(1e-07, 1e-09))

Parameters

device_uid (string) –

messageIdle(_float_tol=(1e-07, 1e-09))

messageOffline(_float_tol=(1e-07, 1e-09))

messagePairing(network_id=None, pairing_parameters=None, connection_parameters=None, _float_tol=(1e-07, 1e-09))

Parameters

• network_id (string) –

• pairing_parameters (olympe.messages.microhard.PairingParameters()) –

• connection_parameters (olympe.messages.microhard.ConnectionParameters()) –

enumolympe.enums.microhard.Bandwidth

1mhz

2mhz

4mhz

8mhz

enumolympe.enums.microhard.Encryption

none

aes128

aes256

enumolympe.enums.microhard.HardwareErrorCause

internal

enumolympe.enums.microhard.PairingFailureReason

internal_error

already_paired

device_not_reachable

invalid_state

invalid_config