SmartWaveAPI.definitions package
Module contents
All of the value definitions for the correct communication with a SmartWave device.
SmartWaveAPI.definitions.command module
- class SmartWaveAPI.definitions.command.Command(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
The first byte of a command frame to be sent to the device; specifies the meaning of the following bytes.
- Driver = 4
- DriverPinMatrix = 7
- FirmwareUpdate = 11
- FpgaRead = 14
- FpgaUpdate = 12
- FpgaWrite = 13
- General = 8
- Heartbeat = 10
- Info = 9
- Pin = 5
- Reset = 0
- Stimulus = 3
- StimulusDriverMatrix = 6
- Stop = 2
- Trigger = 1
SmartWaveAPI.definitions.drivertype module
SmartWaveAPI.definitions.i2ctransaction module
- class SmartWaveAPI.definitions.i2ctransaction.I2CRead(deviceId: int, length: int)
Bases:
object
A read operation on an I2C driver
- class SmartWaveAPI.definitions.i2ctransaction.I2CWrite(deviceId: int, data: bytes)
Bases:
object
A write operation on an I2C driver
SmartWaveAPI.definitions.statusbit module
- class SmartWaveAPI.definitions.statusbit.ErrorCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
Specifies the type of error that occurred.
- FPGACorrupt = 1
- FirmwareCorrupt = 0
- class SmartWaveAPI.definitions.statusbit.Statusbit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
The first byte of a status frame sent by the device; specifies the meaning of the following bytes
- Debug = 5
- Error = 3
- FirmwareUpdateFailed = 7
- FirmwareUpdateOk = 6
- FirmwareUpdateStatus = 11
- Idle = 1
- Info = 4
- PinsStatus = 10
- Readback = 8
- Running = 2
- SingleAddressRead = 9