sensor package

Submodules

sensor.BH1750FVI module

class sensor.BH1750FVI.BH1750FVI(address: int = 35)

Bases: object

Digital Light Sensor Client Object. See: https://docs.rs-online.com/f199/0900766b81539909.pdf

Parameters

address – digital light sensor address.

static convert_to_number(data: List) → float

Simple function to convert 2 bytes of data into a decimal number.

Parameters

data – sensor data list.

Returns

convert to number from sensor data list.

get_light(command: int = 32) → float

Read the lux (light value) from the sensor and return it.

Parameters

command – one time command

Returns

Digital light sensor lux.

power_down() → None

Set digital light sensor to power down.

power_on() → None

Set digital light sensor to power on.

read(register: int) → List

Read digital light sensor data.

Parameters

register – command

Returns

Digital light sensor data.

reset() → None

Reset digital light sensor.

write(register: int) → None

Write byte digital light sensor.

Parameters

register – command

sensor.BH1750FVI.debug() → None

debug function.

sensor.CO2MINI module

class sensor.CO2MINI.CO2MINI(use_decrypt: bool = False, device: str = '/dev/hidraw0')

Bases: object

CO2 Sensor Client Object. See: https://hackaday.io/project/5301-reverse-engineering-a-low-cost-usb-co-monitor/log/17909-all-your-base-are-belong-to-us

Parameters

  • use_decrypt – use decrypt flag

  • device – USB device path

get_co2() → float

Get CO2 data from sensor and return it.

Returns

co2 value

get_humidity() → float

Get humidity data from sensor and return it.

Returns

humidity value

get_temperature() → float

Get temperature data from sensor and return it.

Returns

temperature value

read_data() → bool

Read CO2 Sensor data.

Returns

Whether read data was possible.

sensor.CO2MINI.debug() → None

debug function.

sensor.SHT31 module

class sensor.SHT31.SHT31(address: int = 68)

Bases: object

Temperature and Humidity Sensor Client Object. See: https://sensirion.com/media/documents/213E6A3B/63A5A569/Datasheet_SHT3x_DIS.pdf

Parameters

address – Temperature and Humidity Sensor address

get_humidity() → float

Read the humidity from the sensor and return it.

Returns

humidity value

get_temperature() → float

Read the temperature from the sensor and return it.

Returns

temperature value

get_temperature_humidity() → Tuple[float, float]

Read the temperature, humidity from the sensor and return it.

Returns

temperature, humidity value

read(register: int) → int

Read and return a byte from the specified 16-bit register address.

Parameters

register – sensor register address

Returns

Temperature and Humidity Sensor data

read_list(register: int, length: int) → List

Read and return a byte list from the specified 16-bit register address.

Parameters

  • register – sensor register address

  • length – read byte length

Returns

Temperature and Humidity Sensor data

write(register: int, value: int) → None

Write 1 byte of data from the specified 16-bit register address.

Parameters

  • register – sensor register address

  • value – write data

write_list(register: int, data: Sequence[int]) → None

Write 1 byte of data from the specified 16-bit register address.

Parameters

  • register – sensor register address

  • data – write data

sensor.SHT31.debug() → None

debug function.

sensor.VL6180 module

class sensor.VL6180.VL6180X(address: int = 41)

Bases: object

Infrared Distance Sensor Client Object. See: https://www.st.com/ja/imaging-and-photonics-solutions/vl6180x.html

Parameters

address – distance sensor address

get_distance() → float

Read the range of an object in front of sensor and return it in mm.

Returns

distance value

get_light() → float

Read the lux (light value) from the sensor and return it.

Returns

lux value

read(register16: int) → int

Read and return a byte from the specified 16-bit register address.

Parameters

register16 – sensor register address

Returns

Infrared Distance Sensor data.

read16(register16: int) → int

Read and return a 16-bit unsigned big endian value read from the specified 16-bit register address.

Parameters

register16 – sensor register address

Returns

Infrared Distance Sensor data.

write_byte(register16: int, data: int) → None

Write 1 byte of data from the specified 16-bit register address.

Parameters

  • register16 – sensor register address

  • data – write data

write_byte16(register16: int, data16: int) → None

Write a 16-bit big endian value to the specified 16-bit register address.

Parameters

  • register16 – sensor register address

  • data16 – write data

sensor.VL6180.debug() → None

debug function.

sensor.relay_module module

sensor.web_camera_module module

class sensor.web_camera_module.WebCameraModule(device_id: int = 0)

Bases: object

Web Camera Client Object.

Parameters

device_id – device id

static decode_fourcc(v) → str

Decode function to fourcc string.

Parameters

v – frame fourcc number

Returns

frame fourcc string

save_photo(save_path: str, settings: Optional[Dict] = None, with_datetime: bool = True) → bool

Save a web camera photo.

Parameters

  • save_path – save web camera photo path

  • settings – video capture frame settings

  • with_datetime – with datetime text

Returns

A boolean if success to save a web camera photo.

sensor.web_camera_module.debug() → None

debug function.

Module contents