InscoperBoxDriverDescription¶
Bases: DriverDescription
The InscoperBoxDriverDescription class provides information for devices supported by the device controller.
Notes: This class is non-copyable and non-movable.
This class describes the driver for a device supported by the controller, including its hardware identification, firmware CRC, and a list of available connections (e.g., TTL, PWM, Analog).
__init__()
¶
Default constructor.
Initializes a new instance of the InscoperBoxDriverDescription class.
getHardwareId()
¶
Get the device hardware ID.
Retrieves the unique hardware identifier of the device associated with this driver.
Returns:
| Type | Description |
|---|---|
int
|
The device hardware ID |
setHardwareId(hardwareId)
¶
Set the device hardware ID.
Sets the unique hardware identifier of the device associated with this driver.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hardwareId
|
int
|
The device hardware ID |
required |
getProjectName()
¶
Get the internal reference of the device.
Retrieves the internal reference of the device in the firmware.
Returns:
| Type | Description |
|---|---|
str
|
The internal reference of the device |
setProjectName(projectName)
¶
Set the internal reference of the device.
Sets the internal reference of the device in the firmware.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
projectName
|
string
|
The internal reference of the device |
required |
getFunctionProjectName()
¶
Get the internal reference of the function.
Retrieves the internal reference of the function in the firmware.
Returns:
| Type | Description |
|---|---|
str
|
The internal reference of the function |
setFunctionProjectName(functionProjectName)
¶
Set the internal reference of the function.
Sets the internal reference of the function in the firmware.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
functionProjectName
|
string
|
The internal reference of the function |
required |
getCrc32()
¶
Get the CRC32 of the device.
Retrieves the CRC32 of the device driver.
Returns:
| Type | Description |
|---|---|
int
|
The CRC32 of the device |
setCrc32(crc32)
¶
Set the CRC32 of the device.
Sets the CRC32 of the device driver.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
crc32
|
int
|
The CRC32 of the device |
required |
addConnectionDescription(connectionDescription)
¶
Add a connection to the list.
Appends a connection to the connections list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connectionDescription
|
ConnectionDescription
|
The connection to add |
required |
setConnectionDescriptionList(connectionDescriptionList)
¶
Set the list of connection.
Replaces the current list of supported connections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connectionDescriptionList
|
list[ConnectionDescription]
|
The list of connections |
required |
getConnectionDescriptionList()
¶
Get the list of connections
Retrieves the list of connections supported by this driver.
Returns:
| Type | Description |
|---|---|
list[ConnectionDescription]
|
The ConnectionDescription list |
getConnectionDescription(tag)
¶
Get the connection corresponding to the given tag
Retrieves a specific connection by its tag.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tag
|
int
|
The ConnectionDescription tag |
required |
Returns:
| Type | Description |
|---|---|
ConnectionDescription
|
The ConnectionDescription if found, otherwise nullptr |