sen5xlib

package

v0.1.0 Latest Latest Go to latest Published: Aug 11, 2023 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aggellos2001/sen5x-go

Links

Open Source Insights

Documentation ¶

Index ¶

func ClearDeviceStatus() error
func FreeHal()
func InitializeHal()
func ReadAccelerationMode() (mode int, err error)
func ReadDataReady() (bool, error)
func ReadDeviceStatus() (status int, err error)
func ReadFanCleaningInterval() (interval int, err error)
func ReadFirmwareVersion() (string, error)
func ReadNOxTuningParameters() (index_offset, learning_time_offset_hours, learning_time_gain_hours, ... int, ...)
func ReadProductName() (string, error)
func ReadSerialNumber() (string, error)
func ReadTemperatureCompensationParameters() (int, int, int, error)
func ReadVOCAlgorithmState() (state, statesize int, err error)
func ReadVOCTuningParameters() (index_offset int, learning_time_offset_hours int, learning_time_gain_hours int, ...)
func ReadWarmStartParameter() (int, error)
func ResetDevice() error
func SetAccelerationMode(mode int) error
func SetFanCleaningInterval(interval int) error
func SetNOxTuningParameters(index_offset, learning_time_offset_hours, learning_time_gain_hours, ... int) error
func SetTemperatureCompensationParameters(temp_offset int, slope int, time_constant int) error
func SetVOCAlgorithmState(state, statesize int) error
func SetVOCTuningParameters(index_offset int, learning_time_offset_hours int, learning_time_gain_hours int, ...) error
func SetWarmStartParameter(warm_start int) error
func SleepHal(seconds uint32)
func StartFanCleaning() error
func StartMeasurement() error
func StartMeasurementWithoutPM() error
func StopMeasurement() error
type SensorMeasurement
- func ReadMeasuredValues() (SensorMeasurement, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FreeHal ¶

func FreeHal()

func InitializeHal ¶

func InitializeHal()

func ReadAccelerationMode ¶

func ReadAccelerationMode() (mode int, err error)

Read/ Write RH/T Acceleration Mode (0x60F7)

func ReadFanCleaningInterval ¶

func ReadFanCleaningInterval() (interval int, err error)

Read/ Write Fan Cleaning Interval (0x5603)

func ReadNOxTuningParameters ¶

func ReadNOxTuningParameters() (index_offset, learning_time_offset_hours,
	learning_time_gain_hours, gating_max_duration_minutes, std_initial,
	gain_factor int, err error)

Read/ Write NOx Algorithm Tuning Parameters (0x60E1)

func ReadTemperatureCompensationParameters ¶

func ReadTemperatureCompensationParameters() (int, int, int, error)

Read / Write Temperature Compensation Parameters (0x60B2)

func ReadVOCTuningParameters ¶

func ReadVOCTuningParameters() (index_offset int, learning_time_offset_hours int, learning_time_gain_hours int, gating_max_duration_minutes int, std_initial int, gain_factor int, err error)

Read/ Write VOC Algorithm Tuning Parameters (0x60D0)

func ReadWarmStartParameter ¶

func ReadWarmStartParameter() (int, error)

Read/ Write Warm Start Parameter (0x60C6)

func SetAccelerationMode ¶

func SetAccelerationMode(mode int) error

func SetFanCleaningInterval ¶

func SetFanCleaningInterval(interval int) error

func SetNOxTuningParameters ¶

func SetNOxTuningParameters(index_offset, learning_time_offset_hours, learning_time_gain_hours, gating_max_duration_minutes, std_initial, gain_factor int) error

func SetTemperatureCompensationParameters ¶

func SetTemperatureCompensationParameters(temp_offset int, slope int, time_constant int) error

func SetVOCAlgorithmState ¶

func SetVOCAlgorithmState(state, statesize int) error

func SetVOCTuningParameters ¶

func SetVOCTuningParameters(index_offset int, learning_time_offset_hours int, learning_time_gain_hours int, gating_max_duration_minutes int, std_initial int, gain_factor int) error

func SetWarmStartParameter ¶

func SetWarmStartParameter(warm_start int) error

func SleepHal ¶

func SleepHal(seconds uint32)

func StartMeasurementWithoutPM ¶

func StartMeasurementWithoutPM() error

Start Measurement in RHT/Gas-Only Measurement Mode (0x0037)

Types ¶

type SensorMeasurement ¶

type SensorMeasurement struct {
	PM1_0  uint
	PM2_5  uint
	PM4_0  uint
	PM10_0 uint
	Hum    int
	Temp   int
	VOC    int
	NOx    int
}

Different models of the SEN5x sensor family may have different features. The negative max value of a non-existing feature is used to indicate that the feature is not available. (e.g. NOx for SEN54 which is not unsigned as you can notice)

func ReadMeasuredValues ¶

func ReadMeasuredValues() (SensorMeasurement, error)

Read Measured Values (0x03C4)

Source Files ¶

View all Source files

sen5x.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL