# This file was auto-generated. Do not modify.
from ._bs_c_cffi import ffi
from . import _BS_C #imported from __init__
from .Entity_Entity import *
from .result import Result
from .ffi_utils import data_to_bytearray, bytes_to_string, handle_sign, handle_sign_value, get_ffi_buffer
[docs]class Port(Entity):
'''
The Port Entity provides software control over the most basic items related to a USB Port.
This includes everything from the complete enable and disable of the entire port to the
individual control of specific pins.
Voltage and Current measurements are also included for devices which support the Port
Entity.
'''
def __init__(self, module, index):
super(Port, self).__init__(module, _BS_C.cmdPORT, index)
[docs] def getVbusVoltage(self):
'''
Gets the Vbus Voltage
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The voltage in microvolts (1 == 1e-6V) currently present on Vbus.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVbusVoltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getVbusCurrent(self):
'''
Gets the Vbus Current
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The current in microamps (1 == 1e-6A) currently present on Vbus.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVbusCurrent(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getVconnVoltage(self):
'''
Gets the Vconn Voltage
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The voltage in microvolts (1 == 1e-6V) currently present on Vconn.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconnVoltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getVconnCurrent(self):
'''
Gets the Vconn Current
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The current in microamps (1 == 1e-6A) currently present on Vconn.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconnCurrent(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getPowerMode(self):
'''
Gets the Port Power Mode: Convenience Function of get/setPortMode
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
The current power mode.
'''
result = ffi.new("struct Result*")
_BS_C.port_getPowerMode(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setPowerMode(self, power_mode):
'''
Sets the Port Power Mode: Convenience Function of get/setPortMode
Parameters
----------
power_mode : unsigned char
The power mode to be set.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setPowerMode(self._module._id_pointer, result, self._index, power_mode)
return result.error
[docs] def getEnabled(self):
'''
Gets the current enable value of the port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Fully enabled port; 0 = One or more disabled components.
'''
result = ffi.new("struct Result*")
_BS_C.port_getEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setEnabled(self, enable):
'''
Enables or disables the entire port.
Parameters
----------
enable : bool
1 = Fully enable port; 0 = Fully disable port.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataEnabled(self):
'''
Gets the current enable value of the data lines.
Sub-component (Data) of getEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataEnabled(self, enable):
'''
Enables or disables the data lines.
Sub-component (Data) of setEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataHSEnabled(self):
'''
Gets the current enable value of the High Speed (HS) data lines.
Sub-component of getDataEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataHSEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataHSEnabled(self, enable):
'''
Enables or disables the High Speed (HS) data lines.
Sub-component of setDataEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataHSEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataHS1Enabled(self):
'''
Gets the current enable value of the High Speed A side (HSA) data lines.
Sub-component of getDataHSEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataHS1Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataHS1Enabled(self, enable):
'''
Enables or disables the High Speed A side (HSA) data lines.
Sub-component of setDataHSEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataHS1Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataHS2Enabled(self):
'''
Gets the current enable value of the High Speed B side (HSB) data lines.
Sub-component of getDataHSEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataHS2Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataHS2Enabled(self, enable):
'''
Enables or disables the High Speed B side (HSB) data lines.
Sub-component of setDataHSEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataHS2Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataSSEnabled(self):
'''
Gets the current enable value of the Super Speed (SS) data lines.
Sub-component of getDataEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataSSEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataSSEnabled(self, enable):
'''
Enables or disables the Super Speed (SS) data lines.
Sub-component of setDataEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataSSEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataSS1Enabled(self):
'''
Gets the current enable value of the Super Speed A side (SSA) data lines.
Sub-component of getDataSSEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataSS1Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataSS1Enabled(self, enable):
'''
Enables or disables the Super Speed (SS) data lines.
Sub-component of setDataEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataSS1Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataSS2Enabled(self):
'''
Gets the current enable value of the Super Speed B side (SSB) data lines.
Sub-component of getDataSSEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Data enabled; 0 = Data disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataSS2Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataSS2Enabled(self, enable):
'''
Enables or disables the Super Speed B side (SSB) data lines.
Sub-component of setDataSSEnabled.
Parameters
----------
enable : bool
1 = Enable data; 0 = Disable data.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataSS2Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getPowerEnabled(self):
'''
Gets the current enable value of the power lines. Sub-component (Power) of getEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Power enabled; 0 = Power disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getPowerEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setPowerEnabled(self, enable):
'''
Enables or Disables the power lines. Sub-component (Power) of setEnable.
Parameters
----------
enable : bool
1 = Enable power; 0 = Disable disable.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setPowerEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getDataRole(self):
'''
Gets the Port Data Role.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
The data role to be set. See datasheet for details.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataRole(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def getVconnEnabled(self):
'''
Gets the current enable value of the Vconn lines.
Sub-component (Vconn) of getEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Vconn enabled; 0 = Vconn disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconnEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setVconnEnabled(self, enable):
'''
Enables or disables the Vconn lines.
Sub-component (Vconn) of setEnabled.
Parameters
----------
enable : bool
1 = Enable Vconn lines; 0 = Disable Vconn lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVconnEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getVconn1Enabled(self):
'''
Gets the current enable value of the Vconn1 lines.
Sub-component of getVconnEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Vconn1 enabled; 0 = Vconn1 disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconn1Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setVconn1Enabled(self, enable):
'''
Enables or disables the Vconn1 lines.
Sub-component of setVconnEnabled.
Parameters
----------
enable : bool
1 = Enable Vconn1 lines; 0 = Disable Vconn1 lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVconn1Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getVconn2Enabled(self):
'''
Gets the current enable value of the Vconn2 lines.
Sub-component of getVconnEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = Vconn2 enabled; 0 = Vconn2 disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconn2Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setVconn2Enabled(self, enable):
'''
Enables or disables the Vconn2 lines.
Sub-component of setVconnEnabled.
Parameters
----------
enable : bool
1 = Enable Vconn2 lines; 0 = Disable Vconn2 lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVconn2Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getCCEnabled(self):
'''
Gets the current enable value of the CC lines.
Sub-component (CC) of getEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = CC enabled; 0 = CC disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCCEnabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setCCEnabled(self, enable):
'''
Enables or disables the CC lines.
Sub-component (CC) of setEnabled.
Parameters
----------
enable : bool
1 = Enable CC lines; 0 = Disable CC lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCCEnabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getCC1Enabled(self):
'''
Gets the current enable value of the CC1 lines.
Sub-component of getCCEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = CC1 enabled; 0 = CC1 disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC1Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setCC1Enabled(self, enable):
'''
Enables or disables the CC1 lines.
Sub-component of setCCEnabled.
Parameters
----------
enable : bool
1 = Enable CC1 lines; 0 = Disable CC1 lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCC1Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getCC2Enabled(self):
'''
Gets the current enable value of the CC2 lines.
Sub-component of getCCEnabled.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : bool
1 = CC2 enabled; 0 = CC2 disabled.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC2Enabled(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setCC2Enabled(self, enable):
'''
Enables or disables the CC2 lines.
Sub-component of setCCEnabled.
Parameters
----------
enable : bool
1 = Enable CC2 lines; 0 = Disable CC2 lines.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCC2Enabled(self._module._id_pointer, result, self._index, enable)
return result.error
[docs] def getVoltageSetpoint(self):
'''
Gets the current voltage setpoint value for the port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
the voltage setpoint of the port in uV.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVoltageSetpoint(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def setVoltageSetpoint(self, value):
'''
Sets the current voltage setpoint value for the port.
Parameters
----------
value : unsigned int
the voltage setpoint of the port in uV.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVoltageSetpoint(self._module._id_pointer, result, self._index, value)
return result.error
[docs] def getState(self):
'''
A bit mapped representation of the current state of the port.
Reflects what he port IS which may differ from what was requested.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Variable to be filled with the current state.
'''
result = ffi.new("struct Result*")
_BS_C.port_getState(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def getDataSpeed(self):
'''
Gets the speed of the enumerated device.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Bit mapped value representing the devices speed.
See "Devices" reference for details.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataSpeed(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def getMode(self):
'''
Gets current mode of the port
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Bit mapped value representing the ports mode.
See "Devices" reference for details.
'''
result = ffi.new("struct Result*")
_BS_C.port_getMode(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def setMode(self, mode):
'''
Sets the mode of the port
Parameters
----------
mode : unsigned int
Port mode to be set. See "Devices" documentation for details.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setMode(self._module._id_pointer, result, self._index, mode)
return result.error
[docs] def getErrors(self):
'''
Returns any errors that are present on the port.
Calling this function will clear the current errors. If the error persists it will be set
again.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Bit mapped field representing the current errors of the ports
'''
result = ffi.new("struct Result*")
_BS_C.port_getErrors(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def getCurrentLimit(self):
'''
Gets the current limit of the port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Variable to be filled with the limit in microAmps (uA).
'''
result = ffi.new("struct Result*")
_BS_C.port_getCurrentLimit(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def setCurrentLimit(self, limit):
'''
Sets the current limit of the port.
Parameters
----------
limit : unsigned int
Current limit to be applied in microAmps (uA).
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCurrentLimit(self._module._id_pointer, result, self._index, limit)
return result.error
[docs] def getCurrentLimitMode(self):
'''
Gets the current limit mode.
The mode determines how the port will react to an over current condition.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Variable to be filled with an enumerated representation of the current limit
mode.
Available modes are product specific. See the reference documentation.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCurrentLimitMode(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setCurrentLimitMode(self, mode):
'''
Sets the current limit mode.
The mode determines how the port will react to an over current condition.
Parameters
----------
mode : unsigned char
An enumerated representation of the current limit mode.
Available modes are product specific. See the reference documentation.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCurrentLimitMode(self._module._id_pointer, result, self._index, mode)
return result.error
[docs] def getAvailablePower(self):
'''
Gets the current available power.
This value is determined by the power manager which is responsible for budgeting the
systems available power envelope.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Variable to be filled with the available power in milli-watts (mW).
'''
result = ffi.new("struct Result*")
_BS_C.port_getAvailablePower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def getAllocatedPower(self):
'''
Gets the currently allocated power
This value is determined by the power manager which is responsible for budgeting the
systems available power envelope.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
Variable to be filled with the allocated power in milli-watts (mW).
'''
result = ffi.new("struct Result*")
_BS_C.port_getAllocatedPower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getPowerLimit(self):
'''
Gets the user defined power limit for the port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned int
Variable to be filled with the power limit in milli-watts (mW).
'''
result = ffi.new("struct Result*")
_BS_C.port_getPowerLimit(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, False)
[docs] def setPowerLimit(self, limit):
'''
Sets a user defined power limit for the port.
Parameters
----------
limit : unsigned int
Power limit to be applied in milli-watts (mW).
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setPowerLimit(self._module._id_pointer, result, self._index, limit)
return result.error
[docs] def getPowerLimitMode(self):
'''
Gets the power limit mode.
The mode determines how the port will react to an over power condition.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Variable to be filled with an enumerated representation of the power limit
mode.
Available modes are product specific. See the reference documentation.
'''
result = ffi.new("struct Result*")
_BS_C.port_getPowerLimitMode(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setPowerLimitMode(self, mode):
'''
Sets the power limit mode.
The mode determines how the port will react to an over power condition.
Parameters
----------
mode : unsigned char
An enumerated representation of the power limit mode to be applied
Available modes are product specific. See the reference documentation.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setPowerLimitMode(self._module._id_pointer, result, self._index, mode)
return result.error
[docs] def getName(self, buffer_length = 65536):
'''
Gets a user defined name of the port.
Helpful for identifying ports/devices in a static environment.
Parameters
----------
buffer_length : unsigned int
Length of the buffer to be filed
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : string
pointer to the start of a c style buffer to be filled
'''
ffi_buffer = get_ffi_buffer(8, False, buffer_length)
result = ffi.new("struct Result*")
_BS_C.port_getName(self._module._id_pointer, result, self._index, ffi_buffer, buffer_length)
return_list = [handle_sign_value(ffi_buffer[i], 8, False) for i in range(result.value)]
return Result(result.error, bytes(return_list).decode('utf-8'))
[docs] def setName(self, buffer):
'''
Sets a user defined name of the port.
Helpful for identifying ports/devices in a static environment.
Parameters
----------
buffer : string
Pointer to the start of a c style buffer to be transferred.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
buffer = data_to_bytearray(buffer)
buffer_length = len(buffer)
ffi_buffer = get_ffi_buffer(8, False, buffer_length)
for x in range(buffer_length):
ffi_buffer[x] = buffer[x]
result = ffi.new("struct Result*")
_BS_C.port_setName(self._module._id_pointer, result, self._index, ffi_buffer, buffer_length)
return result.error
[docs] def getCCCurrentLimit(self):
'''
Gets the CC Current Limit Resistance
The CC Current limit is the value that's set for the pull up resistance on the CC lines
for basic USB-C negotations.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Variable to be filled with an enumerated representation of the CC Current
limit.
- 0 = None
- 1 = Default (500/900mA)
- 2 = 1.5A
- 3 = 3.0A
'''
result = ffi.new("struct Result*")
_BS_C.port_getCCCurrentLimit(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setCCCurrentLimit(self, value):
'''
Sets the CC Current Limit Resistance
The CC Current limit is the value that's set for the pull up resistance on the CC lines
for basic USB-C negotations.
Parameters
----------
value : unsigned char
Variable to be filled with an enumerated representation of the CC Current limit.
- 0 = None
- 1 = Default (500/900mA)
- 2 = 1.5A
- 3 = 3.0A
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCCCurrentLimit(self._module._id_pointer, result, self._index, value)
return result.error
[docs] def getDataHSRoutingBehavior(self):
'''
Gets the HighSpeed Data Routing Behavior.
The mode determines how the port will route the data lines.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Variable to be filled with an enumerated representation of the routing
behavior.
Available modes are product specific. See the reference documentation.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataHSRoutingBehavior(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataHSRoutingBehavior(self, mode):
'''
Sets the HighSpeed Data Routing Behavior.
The mode determines how the port will route the data lines.
Parameters
----------
mode : unsigned char
An enumerated representation of the routing behavior.
Available modes are product specific. See the reference documentation.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataHSRoutingBehavior(self._module._id_pointer, result, self._index, mode)
return result.error
[docs] def getDataSSRoutingBehavior(self):
'''
Gets the SuperSpeed Data Routing Behavior.
The mode determines how the port will route the data lines.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
Variable to be filled with an enumerated representation of the routing
behavior.
Available modes are product specific. See the reference documentation.
'''
result = ffi.new("struct Result*")
_BS_C.port_getDataSSRoutingBehavior(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def setDataSSRoutingBehavior(self, mode):
'''
Sets the SuperSpeed Data Routing Behavior.
The mode determines how the port will route the data lines.
Parameters
----------
mode : unsigned char
An enumerated representation of the routing behavior.
Available modes are product specific. See the reference documentation.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setDataSSRoutingBehavior(self._module._id_pointer, result, self._index, mode)
return result.error
[docs] def getVbusAccumulatedPower(self):
'''
Gets the Vbus Accumulated Power
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The accumulated power on Vbus in milliwatt-hours.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVbusAccumulatedPower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def setVbusAccumulatedPower(self, milliwatthours):
'''
Sets the Vbus Accumulated Power
Parameters
----------
milliwatthours : int
The accumulated power on Vbus in milliwatt-hours to be set.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVbusAccumulatedPower(self._module._id_pointer, result, self._index, milliwatthours)
return result.error
[docs] def resetVbusAccumulatedPower(self):
'''
Resets the Vbus Accumulated Power to zero.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_resetVbusAccumulatedPower(self._module._id_pointer, result, self._index)
return result.error
[docs] def getVconnAccumulatedPower(self):
'''
Gets the Vconn Accumulated Power
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The accumulated power on Vconn in milliwatt-hours.
'''
result = ffi.new("struct Result*")
_BS_C.port_getVconnAccumulatedPower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def setVconnAccumulatedPower(self, milliwatthours):
'''
Sets the Vconn Accumulated Power
Parameters
----------
milliwatthours : int
The accumulated power on Vconn to be set.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setVconnAccumulatedPower(self._module._id_pointer, result, self._index, milliwatthours)
return result.error
[docs] def resetVconnAccumulatedPower(self):
'''
Resets the Vconn Accumulated Power to zero.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_resetVconnAccumulatedPower(self._module._id_pointer, result, self._index)
return result.error
[docs] def setHSBoost(self, boost):
'''
Sets the ports USB 2.0 High Speed Boost Settings
The setting determines how much additional drive the USB 2.0 signal will have in High
Speed mode.
Parameters
----------
boost : unsigned char
An enumerated representation of the boost range.
Available value are product specific. See the reference documentation.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setHSBoost(self._module._id_pointer, result, self._index, boost)
return result.error
[docs] def getHSBoost(self):
'''
Gets the ports USB 2.0 High Speed Boost Settings
The setting determines how much additional drive the USB 2.0 signal will have in High
Speed mode.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned char
An enumerated representation of the boost range.
Available modes are product specific. See the reference documentation.
'''
result = ffi.new("struct Result*")
_BS_C.port_getHSBoost(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 8, False)
[docs] def getCC1State(self):
'''
Gets the current CC1 Strapping on local and remote
The state is a bit packed value where the upper byte is used to represent the remote or
partner device attached to the ports resistance and the lower byte is used to represent
the local or hubs resistance.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned short
Variable to be filled with an packed enumerated representation of the CC
state.
Enumeration values for each byte are as follows:
- None = 0 = portCC1State_None
- Invalid = 1 = portCC1State_Invalid
- Rp (default) = 2 = portCC1State_RpDefault
- Rp (1.5A) = 3 = portCC1State_Rp1p5
- Rp (3A) = 4 = portCC1State_Rp3p0
- Rd = 5 = portCC1State_Rd
- Ra = 6 = portCC1State_Ra
- Managed by controller = 7 = portCC1State_Managed
- Unknown = 8 = portCC1State_Unknown
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC1State(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 16, False)
[docs] def getCC2State(self):
'''
Gets the current CC2 Strapping on local and remote
The state is a bit packed value where the upper byte is used to represent the remote or
partner device attached to the ports resistance and the lower byte is used to represent
the local or hubs resistance.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : unsigned short
Variable to be filled with an packed enumerated representation of the CC
state.
Enumeration values for each byte are as follows:
- None = 0 = portCC2State_None
- Invalid = 1 = portCC2State_Invalid
- Rp (default) = 2 = portCC2State_RpDefault
- Rp (1.5A) = 3 = portCC2State_Rp1p5
- Rp (3A) = 4 = portCC2State_Rp3p0
- Rd = 5 = portCC2State_Rd
- Ra = 6 = portCC2State_Ra
- Managed by controller = 7 = portCC2State_Managed
- Unknown = 8 = portCC2State_Unknown
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC2State(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 16, False)
[docs] def getSBU1Voltage(self):
'''
Get the voltage of SBU1 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel voltage in micro-volts (1 == 1e-6V).
'''
result = ffi.new("struct Result*")
_BS_C.port_getSBU1Voltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getSBU2Voltage(self):
'''
Get the voltage of SBU2 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel voltage in micro-volts (1 == 1e-6V).
'''
result = ffi.new("struct Result*")
_BS_C.port_getSBU2Voltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getCC1Voltage(self):
'''
Get the voltage of CC1 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel voltage in micro-volts (1 == 1e-6V).
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC1Voltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getCC2Voltage(self):
'''
Get the voltage of CC2 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel voltage in micro-volts (1 == 1e-6V).
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC2Voltage(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getCC1Current(self):
'''
Get the current through the CC1 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel current in micro-amps (1 == 1e-6A).
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC1Current(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getCC2Current(self):
'''
Get the current through the CC2 for a port.
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The USB channel current in micro-amps (1 == 1e-6A).
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC2Current(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def getCC1AccumulatedPower(self):
'''
Sets the CC1 Accumulated Power
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The accumulated power on Vconn in milliwatt-hours.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC1AccumulatedPower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def setCC1AccumulatedPower(self, milliwatthours):
'''
Gets the CC1 Accumulated Power
Parameters
----------
milliwatthours : int
The accumulated power on Vconn to be set.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCC1AccumulatedPower(self._module._id_pointer, result, self._index, milliwatthours)
return result.error
[docs] def getCC2AccumulatedPower(self):
'''
Sets the CC2 Accumulated Power
Returns
-------
brainstem.result.Result
Object containing error code and returned value on success.
error : unsigned byte
An error result from the list of defined error codes
value : int
The accumulated power on Vconn in milliwatt-hours.
'''
result = ffi.new("struct Result*")
_BS_C.port_getCC2AccumulatedPower(self._module._id_pointer, result, self._index)
return handle_sign(Result(result.error, result.value), 32, True)
[docs] def setCC2AccumulatedPower(self, milliwatthours):
'''
Gets the CC2 Accumulated Power
Parameters
----------
milliwatthours : int
The accumulated power on Vconn to be set.
Returns
-------
unsigned byte
An error result from the list of defined error codes in brainstem.result.Result
'''
result = ffi.new("struct Result*")
_BS_C.port_setCC2AccumulatedPower(self._module._id_pointer, result, self._index, milliwatthours)
return result.error