nnspike.unit.spike_status

Classes

BatteryStatus([voltage, percent])	Battery status information from the Spike Prime hub.
ColorSensorStatus([reflected, ambient, color])	Status information for a color sensor connected to the Spike Prime hub.
MotorStatus([position, power, ...])	Status information for a motor connected to the Spike Prime hub.
Position([x, y])	Position information from the Spike Prime hub.
SensorStatus([distance, force, color, gyro, ...])	Status information for all sensors connected to the Spike Prime hub.
SpikeStatus([raw_data])	Class to represent and access the status of a Lego Spike Prime hub.
VectorStatus([x, y, z])	Status information for vector-based sensors (gyro, accelerometer).

class nnspike.unit.spike_status.MotorStatus(position=None, power=None, relative_position=None, speed=None)

Status information for a motor connected to the Spike Prime hub.

position: int | None = None

power: int | None = None

relative_position: int | None = None

speed: int | None = None

classmethod from_dict(data)

Return type:

MotorStatus

__init__(position=None, power=None, relative_position=None, speed=None)

class nnspike.unit.spike_status.ColorSensorStatus(reflected=None, ambient=None, color=None)

Status information for a color sensor connected to the Spike Prime hub.

reflected: int | None = None

ambient: int | None = None

color: int | None = None

classmethod from_dict(data)

Return type:

ColorSensorStatus

__init__(reflected=None, ambient=None, color=None)

class nnspike.unit.spike_status.VectorStatus(x=0.0, y=0.0, z=0.0)

Status information for vector-based sensors (gyro, accelerometer).

x: float = 0.0

y: float = 0.0

z: float = 0.0

classmethod from_dict(data)

Return type:

VectorStatus

__init__(x=0.0, y=0.0, z=0.0)

class nnspike.unit.spike_status.Position(x=0.0, y=0.0)

Position information from the Spike Prime hub.

x: float = 0.0

y: float = 0.0

classmethod from_dict(data)

Return type:

Position

__init__(x=0.0, y=0.0)

class nnspike.unit.spike_status.BatteryStatus(voltage=None, percent=None)

Battery status information from the Spike Prime hub.

voltage: float | None = None

percent: float | None = None

classmethod from_dict(data)

Return type:

BatteryStatus

__init__(voltage=None, percent=None)

class nnspike.unit.spike_status.SensorStatus(distance=None, force=None, color=None, gyro=None, accelerometer=None, position=None)

Status information for all sensors connected to the Spike Prime hub.

distance: int | None = None

force: int | None = None

color: ColorSensorStatus | None = None

gyro: VectorStatus | None = None

accelerometer: VectorStatus | None = None

position: Position | None = None

classmethod from_dict(data)

Return type:

SensorStatus

__init__(distance=None, force=None, color=None, gyro=None, accelerometer=None, position=None)

class nnspike.unit.spike_status.SpikeStatus(raw_data=None)

Class to represent and access the status of a Lego Spike Prime hub.

This class provides a structured way to access the data received from the Spike Prime, including sensor readings, motor positions, and battery status.

__init__(raw_data=None)

Initialize the SpikeStatus object.

Parameters:

raw_data (str | bytes | dict | None) – Optional raw data from the Spike Prime to parse

update(data)

Update the status with new data from the Spike Prime.

Parameters:

data (str | bytes | dict) – Raw data from the Spike Prime (string, bytes, or dictionary)

Return type:

None

__str__()

Return a string representation of the status.

Return type:

str