QwiicScmd.
More...
|
def | __init__ (self, address=None, i2c_driver=None) |
|
def | is_connected (self) |
| Determine if a SCMD device is conntected to the system. More...
|
|
def | begin (self) |
| Initialize the operation of the SCMD module. More...
|
|
def | ready (self) |
| Returns if the driver is ready. More...
|
|
def | busy (self) |
| Returns if the driver is busy. More...
|
|
def | enable (self) |
| Enable driver functions. More...
|
|
def | disable (self) |
| Disable driver functions. More...
|
|
def | reset (self) |
| This is a hack in the Arduino lib - the placeholder is for compatablity. More...
|
|
def | set_drive (self, motorNum, direction, level) |
| Drive a motor at a level. More...
|
|
def | inversion_mode (self, motorNum, polarity) |
| Configure a motor's direction inversion. More...
|
|
def | bridging_mode (self, driverNum, bridged) |
| Configure a driver's bridging state. More...
|
|
def | get_diagnostics (self) |
| Get diagnostic information from the masterd. More...
|
|
def | get_remote_diagnostics (self, address) |
| Get diagnostic information from a slave. More...
|
|
def | reset_diagnostic_counts (self) |
| Reset the master's diagnostic counters. More...
|
|
def | reset_remote_diagnostic_counts (self, address) |
| Reset a slave's diagnostic counters. More...
|
|
def | read_remote_register (self, address, offset) |
| Read data from a slave. More...
|
|
def | write_remote_register (self, address, offset, dataToWrite) |
| Write data from a slave. More...
|
|
QwiicScmd.
- Parameters
-
address | The I2C address to use for the device. If not provided, the default address is used. |
i2c_driver | An existing i2c driver object. If not provided a driver object is created. |
- Returns
- Object The Serial Control Motor Driver device object.
◆ __init__()
def qwiic_scmd.QwiicScmd.__init__ |
( |
|
self, |
|
|
|
address = None , |
|
|
|
i2c_driver = None |
|
) |
| |
◆ begin()
def qwiic_scmd.QwiicScmd.begin |
( |
|
self | ) |
|
Initialize the operation of the SCMD module.
- Returns
- bool Returns true of the initializtion was successful, otherwise False.
◆ bridging_mode()
def qwiic_scmd.QwiicScmd.bridging_mode |
( |
|
self, |
|
|
|
driverNum, |
|
|
|
bridged |
|
) |
| |
Configure a driver's bridging state.
- Parameters
-
driverNum | Number of driver. Master is 0, slave 1 is 1, etc. 0 to 16 |
bridged | 0 or 1 for forward and backward |
- Returns
- No return value
◆ busy()
def qwiic_scmd.QwiicScmd.busy |
( |
|
self | ) |
|
Returns if the driver is busy.
- Returns
- boolean busy status
◆ disable()
def qwiic_scmd.QwiicScmd.disable |
( |
|
self | ) |
|
Disable driver functions.
- Returns
- No return value
◆ enable()
def qwiic_scmd.QwiicScmd.enable |
( |
|
self | ) |
|
Enable driver functions.
- Returns
- No return value
◆ get_diagnostics()
def qwiic_scmd.QwiicScmd.get_diagnostics |
( |
|
self | ) |
|
Get diagnostic information from the masterd.
- Returns
- Object - SCMDDiagnostics() Object returned with properties that are the diagnostic info
◆ get_remote_diagnostics()
def qwiic_scmd.QwiicScmd.get_remote_diagnostics |
( |
|
self, |
|
|
|
address |
|
) |
| |
Get diagnostic information from a slave.
- Parameters
-
address | Address of slave to read. Can be 0x50 to 0x5F for slave 1 to 16. |
- Returns
- Object - SCMDDiagnostics() Object returned with properties that are the diagnostic info
◆ inversion_mode()
def qwiic_scmd.QwiicScmd.inversion_mode |
( |
|
self, |
|
|
|
motorNum, |
|
|
|
polarity |
|
) |
| |
Configure a motor's direction inversion.
- Parameters
-
motoNum | Motor number from 0 to 33 |
polarity | 0 or 1 for default or inverted |
- Returns
- No return value
◆ is_connected()
def qwiic_scmd.QwiicScmd.is_connected |
( |
|
self | ) |
|
Determine if a SCMD device is conntected to the system.
- Returns
- bool True if the device is connected, otherwise False.
◆ read_remote_register()
def qwiic_scmd.QwiicScmd.read_remote_register |
( |
|
self, |
|
|
|
address, |
|
|
|
offset |
|
) |
| |
Read data from a slave.
Note that this waits 5ms for slave data to be aquired before making the final read.
- Parameters
-
address | Address of slave to read. Can be 0x50 to 0x5F for slave 1 to 16. |
offset | Address of data to read. Can be 0x00 to 0x7F |
- Returns
- integer Register Value
◆ ready()
def qwiic_scmd.QwiicScmd.ready |
( |
|
self | ) |
|
Returns if the driver is ready.
- Returns
- boolean Ready status
◆ reset()
def qwiic_scmd.QwiicScmd.reset |
( |
|
self | ) |
|
This is a hack in the Arduino lib - the placeholder is for compatablity.
◆ reset_diagnostic_counts()
def qwiic_scmd.QwiicScmd.reset_diagnostic_counts |
( |
|
self | ) |
|
Reset the master's diagnostic counters.
- Returns
- No return value
◆ reset_remote_diagnostic_counts()
def qwiic_scmd.QwiicScmd.reset_remote_diagnostic_counts |
( |
|
self, |
|
|
|
address |
|
) |
| |
Reset a slave's diagnostic counters.
- Parameters
-
address | Address of slave to read. Can be 0x50 to 0x5F for slave 1 to 16. |
- Returns
- No return value
◆ set_drive()
def qwiic_scmd.QwiicScmd.set_drive |
( |
|
self, |
|
|
|
motorNum, |
|
|
|
direction, |
|
|
|
level |
|
) |
| |
Drive a motor at a level.
- Parameters
-
motoNum | Motor number from 0 to 33 |
direction | 0 or 1 for forward and backward |
level | (-255) to 255 for drive strength |
- Returns
- No return value
◆ write_remote_register()
def qwiic_scmd.QwiicScmd.write_remote_register |
( |
|
self, |
|
|
|
address, |
|
|
|
offset, |
|
|
|
dataToWrite |
|
) |
| |
Write data from a slave.
- Parameters
-
address | Address of slave to read. Can be 0x50 to 0x5F for slave 1 to 16. |
offset | Address of data to read. Can be 0x00 to 0x7F |
dataToWrite | The data to write |
- Returns
- No return value
◆ address
qwiic_scmd.QwiicScmd.address |
◆ available_addresses
qwiic_scmd.QwiicScmd.available_addresses = _AVAILABLE_I2C_ADDRESS |
|
static |
◆ device_name
qwiic_scmd.QwiicScmd.device_name = _DEFAULT_NAME |
|
static |
◆ FIRMWARE_VERSION
int qwiic_scmd.QwiicScmd.FIRMWARE_VERSION = 0x07 |
|
static |
◆ ID_WORD
int qwiic_scmd.QwiicScmd.ID_WORD = 0xA9 |
|
static |
◆ MASTER_LOCK_KEY
int qwiic_scmd.QwiicScmd.MASTER_LOCK_KEY = 0x9B |
|
static |
◆ MAX_POLL_LIMIT
int qwiic_scmd.QwiicScmd.MAX_POLL_LIMIT = 0xC8 |
|
static |
◆ MAX_SLAVE_ADDR
int qwiic_scmd.QwiicScmd.MAX_SLAVE_ADDR = 0x5F |
|
static |
◆ POLL_ADDRESS
int qwiic_scmd.QwiicScmd.POLL_ADDRESS = 0x4A |
|
static |
◆ SCMD_BRIDGE
int qwiic_scmd.QwiicScmd.SCMD_BRIDGE = 0x14 |
|
static |
◆ SCMD_BRIDGE_SLV_H
int qwiic_scmd.QwiicScmd.SCMD_BRIDGE_SLV_H = 0x55 |
|
static |
◆ SCMD_BRIDGE_SLV_L
int qwiic_scmd.QwiicScmd.SCMD_BRIDGE_SLV_L = 0x54 |
|
static |
◆ SCMD_BUSY_BIT
int qwiic_scmd.QwiicScmd.SCMD_BUSY_BIT = 0x02 |
|
static |
◆ SCMD_CONFIG_BITS
int qwiic_scmd.QwiicScmd.SCMD_CONFIG_BITS = 0x03 |
|
static |
◆ SCMD_CONTROL_1
int qwiic_scmd.QwiicScmd.SCMD_CONTROL_1 = 0x78 |
|
static |
◆ SCMD_DRIVER_ENABLE
int qwiic_scmd.QwiicScmd.SCMD_DRIVER_ENABLE = 0x70 |
|
static |
◆ SCMD_E_BUS_SPEED
int qwiic_scmd.QwiicScmd.SCMD_E_BUS_SPEED = 0x73 |
|
static |
◆ SCMD_E_I2C_RD_ERR
int qwiic_scmd.QwiicScmd.SCMD_E_I2C_RD_ERR = 0x07 |
|
static |
◆ SCMD_E_I2C_WR_ERR
int qwiic_scmd.QwiicScmd.SCMD_E_I2C_WR_ERR = 0x08 |
|
static |
◆ SCMD_E_PORT_CLKDIV_CTRL
int qwiic_scmd.QwiicScmd.SCMD_E_PORT_CLKDIV_CTRL = 0x1D |
|
static |
◆ SCMD_E_PORT_CLKDIV_L
int qwiic_scmd.QwiicScmd.SCMD_E_PORT_CLKDIV_L = 0x1C |
|
static |
◆ SCMD_E_PORT_CLKDIV_U
int qwiic_scmd.QwiicScmd.SCMD_E_PORT_CLKDIV_U = 0x1B |
|
static |
◆ SCMD_ENUMERATION_BIT
int qwiic_scmd.QwiicScmd.SCMD_ENUMERATION_BIT = 0x01 |
|
static |
◆ SCMD_FID
int qwiic_scmd.QwiicScmd.SCMD_FID = 0x00 |
|
static |
◆ SCMD_FORCE_UPDATE
int qwiic_scmd.QwiicScmd.SCMD_FORCE_UPDATE = 0x72 |
|
static |
◆ SCMD_FSAFE_CTRL
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_CTRL = 0x1F |
|
static |
◆ SCMD_FSAFE_CYCLE_EXP
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_CYCLE_EXP = 0x10 |
|
static |
◆ SCMD_FSAFE_CYCLE_USER
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_CYCLE_USER = 0x08 |
|
static |
◆ SCMD_FSAFE_DRIVE_KILL
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_DRIVE_KILL = 0x01 |
|
static |
◆ SCMD_FSAFE_FAULTS
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_FAULTS = 0x0E |
|
static |
◆ SCMD_FSAFE_RE_ENUM
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_RE_ENUM = 0x04 |
|
static |
◆ SCMD_FSAFE_REBOOT
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_REBOOT = 0x02 |
|
static |
◆ SCMD_FSAFE_RESTART_MASK
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_RESTART_MASK = 0x06 |
|
static |
◆ SCMD_FSAFE_TIME
int qwiic_scmd.QwiicScmd.SCMD_FSAFE_TIME = 0x76 |
|
static |
◆ SCMD_FULL_RESET_BIT
int qwiic_scmd.QwiicScmd.SCMD_FULL_RESET_BIT = 0x01 |
|
static |
◆ SCMD_GEN_TEST_WORD
int qwiic_scmd.QwiicScmd.SCMD_GEN_TEST_WORD = 0x11 |
|
static |
◆ SCMD_HW_EN_BIT
int qwiic_scmd.QwiicScmd.SCMD_HW_EN_BIT = 0x10 |
|
static |
◆ SCMD_ID
int qwiic_scmd.QwiicScmd.SCMD_ID = 0x01 |
|
static |
◆ SCMD_INV_10_17
int qwiic_scmd.QwiicScmd.SCMD_INV_10_17 = 0x51 |
|
static |
◆ SCMD_INV_18_25
int qwiic_scmd.QwiicScmd.SCMD_INV_18_25 = 0x52 |
|
static |
◆ SCMD_INV_26_33
int qwiic_scmd.QwiicScmd.SCMD_INV_26_33 = 0x53 |
|
static |
◆ SCMD_INV_2_9
int qwiic_scmd.QwiicScmd.SCMD_INV_2_9 = 0x50 |
|
static |
◆ SCMD_LOCAL_MASTER_LOCK
int qwiic_scmd.QwiicScmd.SCMD_LOCAL_MASTER_LOCK = 0x15 |
|
static |
◆ SCMD_LOCAL_USER_LOCK
int qwiic_scmd.QwiicScmd.SCMD_LOCAL_USER_LOCK = 0x16 |
|
static |
◆ SCMD_LOOP_TIME
int qwiic_scmd.QwiicScmd.SCMD_LOOP_TIME = 0x09 |
|
static |
◆ SCMD_M_IN_CYCLE_EXP
int qwiic_scmd.QwiicScmd.SCMD_M_IN_CYCLE_EXP = 0x08 |
|
static |
◆ SCMD_M_IN_CYCLE_USER
int qwiic_scmd.QwiicScmd.SCMD_M_IN_CYCLE_USER = 0x04 |
|
static |
◆ SCMD_M_IN_RE_ENUM
int qwiic_scmd.QwiicScmd.SCMD_M_IN_RE_ENUM = 0x02 |
|
static |
◆ SCMD_M_IN_REBOOT
int qwiic_scmd.QwiicScmd.SCMD_M_IN_REBOOT = 0x01 |
|
static |
◆ SCMD_M_IN_RESTART_MASK
int qwiic_scmd.QwiicScmd.SCMD_M_IN_RESTART_MASK = 0x03 |
|
static |
◆ SCMD_MA_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_MA_DRIVE = 0x20 |
|
static |
◆ SCMD_MASTER_LOCK
int qwiic_scmd.QwiicScmd.SCMD_MASTER_LOCK = 0x74 |
|
static |
◆ SCMD_MB_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_MB_DRIVE = 0x21 |
|
static |
◆ SCMD_MOTOR_A_INVERT
int qwiic_scmd.QwiicScmd.SCMD_MOTOR_A_INVERT = 0x12 |
|
static |
◆ SCMD_MOTOR_B_INVERT
int qwiic_scmd.QwiicScmd.SCMD_MOTOR_B_INVERT = 0x13 |
|
static |
◆ SCMD_MST_E_ERR
int qwiic_scmd.QwiicScmd.SCMD_MST_E_ERR = 0x0C |
|
static |
◆ SCMD_MST_E_IN_FN
int qwiic_scmd.QwiicScmd.SCMD_MST_E_IN_FN = 0x17 |
|
static |
◆ SCMD_MST_E_STATUS
int qwiic_scmd.QwiicScmd.SCMD_MST_E_STATUS = 0x0D |
|
static |
◆ SCMD_RE_ENUMERATE_BIT
int qwiic_scmd.QwiicScmd.SCMD_RE_ENUMERATE_BIT = 0x02 |
|
static |
◆ SCMD_REG_OOR_CNT
int qwiic_scmd.QwiicScmd.SCMD_REG_OOR_CNT = 0x0F |
|
static |
◆ SCMD_REG_RO_WRITE_CNT
int qwiic_scmd.QwiicScmd.SCMD_REG_RO_WRITE_CNT = 0x10 |
|
static |
◆ SCMD_REM_ADDR
int qwiic_scmd.QwiicScmd.SCMD_REM_ADDR = 0x79 |
|
static |
◆ SCMD_REM_DATA_RD
int qwiic_scmd.QwiicScmd.SCMD_REM_DATA_RD = 0x7C |
|
static |
◆ SCMD_REM_DATA_WR
int qwiic_scmd.QwiicScmd.SCMD_REM_DATA_WR = 0x7B |
|
static |
◆ SCMD_REM_OFFSET
int qwiic_scmd.QwiicScmd.SCMD_REM_OFFSET = 0x7A |
|
static |
◆ SCMD_REM_READ
int qwiic_scmd.QwiicScmd.SCMD_REM_READ = 0x7E |
|
static |
◆ SCMD_REM_READ_BIT
int qwiic_scmd.QwiicScmd.SCMD_REM_READ_BIT = 0x04 |
|
static |
◆ SCMD_REM_WRITE
int qwiic_scmd.QwiicScmd.SCMD_REM_WRITE = 0x7D |
|
static |
◆ SCMD_REM_WRITE_BIT
int qwiic_scmd.QwiicScmd.SCMD_REM_WRITE_BIT = 0x08 |
|
static |
◆ SCMD_S10A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S10A_DRIVE = 0x34 |
|
static |
◆ SCMD_S10B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S10B_DRIVE = 0x35 |
|
static |
◆ SCMD_S11A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S11A_DRIVE = 0x36 |
|
static |
◆ SCMD_S11B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S11B_DRIVE = 0x37 |
|
static |
◆ SCMD_S12A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S12A_DRIVE = 0x38 |
|
static |
◆ SCMD_S12B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S12B_DRIVE = 0x39 |
|
static |
◆ SCMD_S13A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S13A_DRIVE = 0x3A |
|
static |
◆ SCMD_S13B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S13B_DRIVE = 0x3B |
|
static |
◆ SCMD_S14A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S14A_DRIVE = 0x3C |
|
static |
◆ SCMD_S14B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S14B_DRIVE = 0x3D |
|
static |
◆ SCMD_S15A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S15A_DRIVE = 0x3E |
|
static |
◆ SCMD_S15B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S15B_DRIVE = 0x3F |
|
static |
◆ SCMD_S16A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S16A_DRIVE = 0x40 |
|
static |
◆ SCMD_S16B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S16B_DRIVE = 0x41 |
|
static |
◆ SCMD_S1A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S1A_DRIVE = 0x22 |
|
static |
◆ SCMD_S1B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S1B_DRIVE = 0x23 |
|
static |
◆ SCMD_S2A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S2A_DRIVE = 0x24 |
|
static |
◆ SCMD_S2B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S2B_DRIVE = 0x25 |
|
static |
◆ SCMD_S3A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S3A_DRIVE = 0x26 |
|
static |
◆ SCMD_S3B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S3B_DRIVE = 0x27 |
|
static |
◆ SCMD_S4A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S4A_DRIVE = 0x28 |
|
static |
◆ SCMD_S4B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S4B_DRIVE = 0x29 |
|
static |
◆ SCMD_S5A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S5A_DRIVE = 0x2A |
|
static |
◆ SCMD_S5B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S5B_DRIVE = 0x2B |
|
static |
◆ SCMD_S6A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S6A_DRIVE = 0x2C |
|
static |
◆ SCMD_S6B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S6B_DRIVE = 0x2D |
|
static |
◆ SCMD_S7A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S7A_DRIVE = 0x2E |
|
static |
◆ SCMD_S7B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S7B_DRIVE = 0x2F |
|
static |
◆ SCMD_S8A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S8A_DRIVE = 0x30 |
|
static |
◆ SCMD_S8B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S8B_DRIVE = 0x31 |
|
static |
◆ SCMD_S9A_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S9A_DRIVE = 0x32 |
|
static |
◆ SCMD_S9B_DRIVE
int qwiic_scmd.QwiicScmd.SCMD_S9B_DRIVE = 0x33 |
|
static |
◆ SCMD_SLAVE_ADDR
int qwiic_scmd.QwiicScmd.SCMD_SLAVE_ADDR = 0x02 |
|
static |
◆ SCMD_SLV_POLL_CNT
int qwiic_scmd.QwiicScmd.SCMD_SLV_POLL_CNT = 0x0A |
|
static |
◆ SCMD_SLV_TOP_ADDR
int qwiic_scmd.QwiicScmd.SCMD_SLV_TOP_ADDR = 0x0B |
|
static |
◆ SCMD_STATUS_1
int qwiic_scmd.QwiicScmd.SCMD_STATUS_1 = 0x77 |
|
static |
◆ SCMD_U_BUF_DUMPED
int qwiic_scmd.QwiicScmd.SCMD_U_BUF_DUMPED = 0x06 |
|
static |
◆ SCMD_U_BUS_UART_BAUD
int qwiic_scmd.QwiicScmd.SCMD_U_BUS_UART_BAUD = 0x1E |
|
static |
◆ SCMD_U_I2C_RD_ERR
int qwiic_scmd.QwiicScmd.SCMD_U_I2C_RD_ERR = 0x04 |
|
static |
◆ SCMD_U_I2C_WR_ERR
int qwiic_scmd.QwiicScmd.SCMD_U_I2C_WR_ERR = 0x05 |
|
static |
◆ SCMD_U_PORT_CLKDIV_CTRL
int qwiic_scmd.QwiicScmd.SCMD_U_PORT_CLKDIV_CTRL = 0x1A |
|
static |
◆ SCMD_U_PORT_CLKDIV_L
int qwiic_scmd.QwiicScmd.SCMD_U_PORT_CLKDIV_L = 0x19 |
|
static |
◆ SCMD_U_PORT_CLKDIV_U
int qwiic_scmd.QwiicScmd.SCMD_U_PORT_CLKDIV_U = 0x18 |
|
static |
◆ SCMD_UPDATE_RATE
int qwiic_scmd.QwiicScmd.SCMD_UPDATE_RATE = 0x71 |
|
static |
◆ SCMD_USER_LOCK
int qwiic_scmd.QwiicScmd.SCMD_USER_LOCK = 0x75 |
|
static |
◆ START_SLAVE_ADDR
int qwiic_scmd.QwiicScmd.START_SLAVE_ADDR = 0x50 |
|
static |
◆ USER_LOCK_KEY
int qwiic_scmd.QwiicScmd.USER_LOCK_KEY = 0x5C |
|
static |
◆ connected
The documentation for this class was generated from the following file: