micropython: Adding pre-coomit config file.

Signed-off-by: NikhitaR-IFX <Nikhita.Rajasekhar@infineon.com>
pull/644/head
NikhitaR-IFX 2023-04-13 17:49:09 +05:30
rodzic af939e65fa
commit a71c421943
2 zmienionych plików z 48 dodań i 44 usunięć

Wyświetl plik

@ -1,3 +1,3 @@
metadata(description="Driver for XENSIV PAS CO2 sensor.", version="0.1.0") metadata(description="Driver for XENSIV PAS CO2 sensor.", version="0.1.0")
module("pasco2.py", opt=3) module("pasco2.py", opt=3)

Wyświetl plik

@ -4,70 +4,74 @@ from machine import I2C
from utime import sleep, sleep_ms from utime import sleep, sleep_ms
# Sensor Register Address Stack # Sensor Register Address Stack
_PASCO2_REG_SENS_STS = const(0x01) # Sensor status register address _PASCO2_REG_SENS_STS = const(0x01) # Sensor status register address
_PASCO2_REG_MEAS_RATE_H = const(0x02) # Measurement period MSB configuration register address _PASCO2_REG_MEAS_RATE_H = const(0x02) # Measurement period MSB configuration register address
_PASCO2_REG_MEAS_CFG = const(0x04) # Measurement mode configuration register address _PASCO2_REG_MEAS_CFG = const(0x04) # Measurement mode configuration register address
_PASCO2_REG_CO2PPM_H = const(0x05) # CO2 concentration result MSB register address _PASCO2_REG_CO2PPM_H = const(0x05) # CO2 concentration result MSB register address
_PASCO2_REG_MEAS_STS = const(0x07) # Measurement status register address _PASCO2_REG_MEAS_STS = const(0x07) # Measurement status register address
_PASCO2_REG_SENS_RST = const(0x10) # Soft reset register address _PASCO2_REG_SENS_RST = const(0x10) # Soft reset register address
#Error codes # Error codes
_PASCO2_SUCCESS = 0 _PASCO2_SUCCESS = 0
_PASCO2_ERROR = -1 _PASCO2_ERROR = -1
addr = 0 addr = 0
mask = 1 mask = 1
class PASCO2: class PASCO2:
"""IFX - XENSIV PAS CO2 sensor driver""" """IFX - XENSIV PAS CO2 sensor driver"""
# RegAddr, Mask, <Later extend with register access type, bit position etc.> # RegAddr, Mask, <Later extend with register access type, bit position etc.>
regMap = { regMap = {
'REG_SENS_STS_BITF_SENS_RDY' : [_PASCO2_REG_SENS_STS, 0x80], # Sensor status bit "REG_SENS_STS_BITF_SENS_RDY": [_PASCO2_REG_SENS_STS, 0x80], # Sensor status bit
'REG_MEAS_CFG_BITF_OP_MODE' : [_PASCO2_REG_MEAS_CFG, 0x03], # Operation Mode type bit "REG_MEAS_CFG_BITF_OP_MODE": [_PASCO2_REG_MEAS_CFG, 0x03], # Operation Mode type bit
'REG_MEAS_STS_BITF_DATA_RDY' : [_PASCO2_REG_MEAS_STS, 0x10], # Data ready status bit "REG_MEAS_STS_BITF_DATA_RDY": [_PASCO2_REG_MEAS_STS, 0x10], # Data ready status bit
'REG_CO2PPM_H_BITF_CO2_PPM_H': [_PASCO2_REG_CO2PPM_H, 0xFF], # Stored CO2 value bit "REG_CO2PPM_H_BITF_CO2_PPM_H": [_PASCO2_REG_CO2PPM_H, 0xFF], # Stored CO2 value bit
} }
def __init__(self, bus, measInterval=10, sensorAddr=0x28): def __init__(self, bus, measInterval=10, sensorAddr=0x28):
"""" Intialize the sensor and required dependencies """ """ " Intialize the sensor and required dependencies"""
self.bus = bus self.bus = bus
self.sensorAddr = sensorAddr self.sensorAddr = sensorAddr
self.measInterval = measInterval self.measInterval = measInterval
self.softResetCode = b"\xa3" self.softResetCode = b"\xa3"
def _read_reg(self, regAddr, bytesToRead=1): def _read_reg(self, regAddr, bytesToRead=1):
""" Internal function to read data from the sensor register and returns it raw """ """Internal function to read data from the sensor register and returns it raw"""
readVal = self.bus.readfrom_mem(self.sensorAddr, regAddr, bytesToRead) readVal = self.bus.readfrom_mem(self.sensorAddr, regAddr, bytesToRead)
return readVal return readVal
def _write_reg(self, regAddr, writeData): def _write_reg(self, regAddr, writeData):
""" Internal function to write data to sensor register """ """Internal function to write data to sensor register"""
self.bus.writeto_mem(self.sensorAddr, regAddr, writeData) self.bus.writeto_mem(self.sensorAddr, regAddr, writeData)
def _is_sensor_ready(self): def _is_sensor_ready(self):
""" Helper function to check the sensor status """ """Helper function to check the sensor status"""
reg = self.regMap['REG_SENS_STS_BITF_SENS_RDY'] reg = self.regMap["REG_SENS_STS_BITF_SENS_RDY"]
return (self._read_reg(reg[addr])[0] & reg[mask]) return self._read_reg(reg[addr])[0] & reg[mask]
def _soft_reset(self): def _soft_reset(self):
""" Helper function to perform soft reset of the sensor """ """Helper function to perform soft reset of the sensor"""
self._write_reg(_PASCO2_REG_SENS_RST, self.softResetCode) self._write_reg(_PASCO2_REG_SENS_RST, self.softResetCode)
def _set_mode(self, mode): def _set_mode(self, mode):
""" Helper function to set the mode of sensor. Currently supported modes: """Helper function to set the mode of sensor. Currently supported modes:
1. Idle 1. Idle
2. Continuous 2. Continuous
""" """
if mode == 'idle': modeVal = 0x00 if mode == "idle":
if mode == 'continuous': modeVal = 0x02 modeVal = 0x00
if mode == "continuous":
reg = self.regMap['REG_MEAS_CFG_BITF_OP_MODE'] modeVal = 0x02
reg = self.regMap["REG_MEAS_CFG_BITF_OP_MODE"]
readData = self._read_reg(reg[addr])[0] readData = self._read_reg(reg[addr])[0]
writeData = bytes([(readData & ~(reg[mask])) | modeVal]) writeData = bytes([(readData & ~(reg[mask])) | modeVal])
self._write_reg(_PASCO2_REG_MEAS_CFG,writeData) self._write_reg(_PASCO2_REG_MEAS_CFG, writeData)
def initialize(self): def initialize(self):
""" Public function to initialize the sensor """ """Public function to initialize the sensor"""
try: try:
# wait for sensor to be ready # wait for sensor to be ready
sensor_ready = self._is_sensor_ready() sensor_ready = self._is_sensor_ready()
@ -84,30 +88,30 @@ class PASCO2:
self._write_reg(_PASCO2_REG_MEAS_RATE_H, buf) self._write_reg(_PASCO2_REG_MEAS_RATE_H, buf)
# reset operation mode to idle mode # reset operation mode to idle mode
self._set_mode('idle') self._set_mode("idle")
# start continuous mode # start continuous mode
self._set_mode('continuous') self._set_mode("continuous")
return _PASCO2_SUCCESS return _PASCO2_SUCCESS
except: except:
return _PASCO2_ERROR return _PASCO2_ERROR
def getCO2Value(self): def getCO2Value(self):
""" Public function to get the CO2 value """ """Public function to get the CO2 value"""
while True: while True:
try: try:
# get meas status # get meas status
reg = self.regMap['REG_MEAS_STS_BITF_DATA_RDY'] reg = self.regMap["REG_MEAS_STS_BITF_DATA_RDY"]
readStatus = self._read_reg(reg[addr]) readStatus = self._read_reg(reg[addr])
data_ready = readStatus[0] & reg[mask] data_ready = readStatus[0] & reg[mask]
if data_ready: if data_ready:
# get CO2 value # get CO2 value
reg = self.regMap['REG_CO2PPM_H_BITF_CO2_PPM_H'] reg = self.regMap["REG_CO2PPM_H_BITF_CO2_PPM_H"]
readVal = self._read_reg(reg[addr], 2) readVal = self._read_reg(reg[addr], 2)
co2_value = (readVal[0] << 8) | readVal[1] co2_value = (readVal[0] << 8) | readVal[1]
return co2_value return co2_value
except: except:
return _PASCO2_ERROR return _PASCO2_ERROR