![]() |
Qwiic_BMP581_Py
2.0.0-1-g4ecbd9a
Python for SFE Qwiic BMP581
|
Public Member Functions | |
def | __init__ (self, address=None, i2c_driver=None) |
Constructor. More... | |
def | is_connected (self) |
Determines if this device is connected. More... | |
def | begin (self) |
Initializes this device with default parameters. More... | |
def | enable_press (self, enable) |
Enables or disables the pressure sensor. More... | |
def | set_odr_frequency (self, odr) |
Sets the output data rate of the sensor. More... | |
def | set_osr_multipliers (self, config) |
Set the temperature and pressure oversampling multipliers. More... | |
def | soft_reset (self) |
This API performs the soft reset of the sensor. More... | |
def | get_osr_odr_press_config (self) |
Gets the current oversampling and output data rate configuration. More... | |
def | set_osr_odr_press_config (self) |
This API sets the configuration for oversampling temperature, oversampling of pressure and ODR configuration along with pressure enable. More... | |
def | get_iir_config (self) |
Gets the current IIR configuration. More... | |
def | get_power_mode (self) |
Gets the current power mode of the device. More... | |
def | set_power_mode (self, powerMode) |
Sets the power mode of the device. More... | |
def | get_sensor_data (self) |
This API reads the temperature(deg C) or both pressure(Pa) and temperature(deg C) data from the sensor and store it in the bmp5_sensor_data structure instance passed by the user. More... | |
def | get_osr_odr_eff (self) |
This API reads the effective oversampling and output data rate configuration from the sensor. More... | |
def | set_iir_config (self, config) |
This API sets the configuration for IIR of temperature and pressure. More... | |
def | set_oor_configuration (self, config) |
This API sets the configuration for out-of-range pressure threshold, range count limit and IIR. More... | |
def | configure_interrupt (self, intMode, intPol, intOd, intEn) |
This API is used to configure the interrupt settings. More... | |
def | int_source_select (self, select) |
This API is used to enable the interrupts(drdy interrupt, fifo full interrupt,
fifo threshold enable and pressure data out of range interrupt). More... | |
def | get_interrupt_status (self) |
This API is used to get interrupt status. More... | |
def | set_fifo_configuration (self, fifo) |
This API used to set the configurations of fifo in the sensor. More... | |
def | get_fifo_len (self, fifo) |
This API is used to get the length of FIFO data available in the sensor. More... | |
def | get_fifo_data (self, fifo) |
This API is used to read the FIFO data from the sensor. More... | |
def | extract_fifo_data (self, fifo, sensorData) |
This API extract the temperature and/or pressure data from the fifo data which is already read from the fifo. More... | |
def | nvm_read (self, nvmAddr) |
This API is used to perform NVM reads. More... | |
def | nvm_write (self, nvmAddr, nvmWriteData) |
Public Attributes | |
address | |
osrOdrConfig | |
fifo | |
Properties | |
connected = property(is_connected) | |
def qwiic_bmp581.QwiicBMP581.__init__ | ( | self, | |
address = None , |
|||
i2c_driver = None |
|||
) |
Constructor.
int,optional | address: The I2C address to use for the device If not provided, the default address is used |
I2CDriver,optional | i2c_driver: An existing i2c driver object If not provided, a driver object is created |
def qwiic_bmp581.QwiicBMP581.begin | ( | self | ) |
Initializes this device with default parameters.
True
if successful, otherwise False
def qwiic_bmp581.QwiicBMP581.configure_interrupt | ( | self, | |
intMode, | |||
intPol, | |||
intOd, | |||
intEn | |||
) |
This API is used to configure the interrupt settings.
int | intMode: The interrupt mode to set |
Allowable values:
kIntModePulsed
kIntModeLatched
int | intPol: The interrupt polarity to set |
kIntPolActiveLow
kIntPolActiveHigh
int | intOd: The interrupt output type to set |
kIntOdPushPull
kIntOdOpenDrain
int | intEn: The interrupt enable to set |
kEnable
kDisable
def qwiic_bmp581.QwiicBMP581.enable_press | ( | self, | |
enable | |||
) |
Enables or disables the pressure sensor.
int | enable: The value to set |
Allowable values:
kEnable
kDisable
def qwiic_bmp581.QwiicBMP581.extract_fifo_data | ( | self, | |
fifo, | |||
sensorData | |||
) |
This API extract the temperature and/or pressure data from the fifo data which is already read from the fifo.
def qwiic_bmp581.QwiicBMP581.get_fifo_data | ( | self, | |
fifo | |||
) |
This API is used to read the FIFO data from the sensor.
FifoConfiguration | fifo: The fifo configuration |
def qwiic_bmp581.QwiicBMP581.get_fifo_len | ( | self, | |
fifo | |||
) |
This API is used to get the length of FIFO data available in the sensor.
FifoConfiguration | fifo: The fifo configuration |
def qwiic_bmp581.QwiicBMP581.get_iir_config | ( | self | ) |
Gets the current IIR configuration.
def qwiic_bmp581.QwiicBMP581.get_interrupt_status | ( | self | ) |
This API is used to get interrupt status.
def qwiic_bmp581.QwiicBMP581.get_osr_odr_eff | ( | self | ) |
This API reads the effective oversampling and output data rate configuration from the sensor.
def qwiic_bmp581.QwiicBMP581.get_osr_odr_press_config | ( | self | ) |
Gets the current oversampling and output data rate configuration.
def qwiic_bmp581.QwiicBMP581.get_power_mode | ( | self | ) |
Gets the current power mode of the device.
def qwiic_bmp581.QwiicBMP581.get_sensor_data | ( | self | ) |
This API reads the temperature(deg C) or both pressure(Pa) and temperature(deg C) data from the sensor and store it in the bmp5_sensor_data structure instance passed by the user.
def qwiic_bmp581.QwiicBMP581.int_source_select | ( | self, | |
select | |||
) |
This API is used to enable the interrupts(drdy interrupt, fifo full interrupt, fifo threshold enable and pressure data out of range interrupt).
intSourceSelect | select: The interrupt source select to set |
def qwiic_bmp581.QwiicBMP581.is_connected | ( | self | ) |
Determines if this device is connected.
True
if connected, otherwise False
def qwiic_bmp581.QwiicBMP581.nvm_read | ( | self, | |
nvmAddr | |||
) |
This API is used to perform NVM reads.
int | nvmAddr: The NVM address to read |
def qwiic_bmp581.QwiicBMP581.nvm_write | ( | self, | |
nvmAddr, | |||
nvmWriteData | |||
) |
def qwiic_bmp581.QwiicBMP581.set_fifo_configuration | ( | self, | |
fifo | |||
) |
This API used to set the configurations of fifo in the sensor.
If Fifo frame selection is enabled then powermode is set as standby mode, as fifo frame selection enabled without disabling deep-standby mode makes powermode invalid.
def qwiic_bmp581.QwiicBMP581.set_iir_config | ( | self, | |
config | |||
) |
This API sets the configuration for IIR of temperature and pressure.
If IIR value for both temperature and pressure is set a value other than bypass then powermode is set as standby mode, as IIR with value other than bypass without disabling deep-standby mode makes powermode invalid.
def qwiic_bmp581.QwiicBMP581.set_odr_frequency | ( | self, | |
odr | |||
) |
Sets the output data rate of the sensor.
int | odr: The output data rate to set |
def qwiic_bmp581.QwiicBMP581.set_oor_configuration | ( | self, | |
config | |||
) |
This API sets the configuration for out-of-range pressure threshold, range count limit and IIR.
OorPressConfiguration | config: The configuration to set |
def qwiic_bmp581.QwiicBMP581.set_osr_multipliers | ( | self, | |
config | |||
) |
Set the temperature and pressure oversampling multipliers.
OsrOdrPressConfig | config: The configuration to set |
def qwiic_bmp581.QwiicBMP581.set_osr_odr_press_config | ( | self | ) |
This API sets the configuration for oversampling temperature, oversampling of pressure and ODR configuration along with pressure enable.
NOTE: If ODR is set to a value higher than 5Hz then powermode is set as standby mode, as ODR value greater than 5HZ without disabling deep-standby mode makes powermode invalid.
def qwiic_bmp581.QwiicBMP581.set_power_mode | ( | self, | |
powerMode | |||
) |
Sets the power mode of the device.
int | powerMode: The power mode to set |
Allowable powerMode values:
kPowerModeStandby
kPowerModeNormal
kPowerModeForced
kPowerModeContinuous
kPowerModeDeepStandby
def qwiic_bmp581.QwiicBMP581.soft_reset | ( | self | ) |
This API performs the soft reset of the sensor.
qwiic_bmp581.QwiicBMP581.address |
|
static |
|
static |
qwiic_bmp581.QwiicBMP581.fifo |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
qwiic_bmp581.QwiicBMP581.osrOdrConfig |
|
static |