Back to godoc.org
github.com/Tinkerforge/go-api-bindings/particulate_matter_bricklet

package particulate_matter_bricklet

v0.0.0 (b512a79)
Latest Go to latest
Published: Dec 2, 2019 | License: CC0-1.0 | Module: github.com/Tinkerforge/go-api-bindings

Overview

Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10).

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/ParticulateMatter_Bricklet_Go.html.

Index

Constants

const DeviceDisplayName = "Particulate Matter Bricklet"
const DeviceIdentifier = 2110

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function

type Function = uint8
const (
	FunctionGetPMConcentration                      Function = 1
	FunctionGetPMCount                              Function = 2
	FunctionSetEnable                               Function = 3
	FunctionGetEnable                               Function = 4
	FunctionGetSensorInfo                           Function = 5
	FunctionSetPMConcentrationCallbackConfiguration Function = 6
	FunctionGetPMConcentrationCallbackConfiguration Function = 7
	FunctionSetPMCountCallbackConfiguration         Function = 8
	FunctionGetPMCountCallbackConfiguration         Function = 9
	FunctionGetSPITFPErrorCount                     Function = 234
	FunctionSetBootloaderMode                       Function = 235
	FunctionGetBootloaderMode                       Function = 236
	FunctionSetWriteFirmwarePointer                 Function = 237
	FunctionWriteFirmware                           Function = 238
	FunctionSetStatusLEDConfig                      Function = 239
	FunctionGetStatusLEDConfig                      Function = 240
	FunctionGetChipTemperature                      Function = 242
	FunctionReset                                   Function = 243
	FunctionWriteUID                                Function = 248
	FunctionReadUID                                 Function = 249
	FunctionGetIdentity                             Function = 255
	FunctionCallbackPMConcentration                 Function = 10
	FunctionCallbackPMCount                         Function = 11
)

type ParticulateMatterBricklet

type ParticulateMatterBricklet struct {
	// contains filtered or unexported fields
}

func New

func New(uid string, ipcon *ipconnection.IPConnection) (ParticulateMatterBricklet, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*ParticulateMatterBricklet) DeregisterPMConcentrationCallback

func (device *ParticulateMatterBricklet) DeregisterPMConcentrationCallback(registrationId uint64)

Remove a registered PM Concentration callback.

func (*ParticulateMatterBricklet) DeregisterPMCountCallback

func (device *ParticulateMatterBricklet) DeregisterPMCountCallback(registrationId uint64)

Remove a registered PM Count callback.

func (*ParticulateMatterBricklet) GetAPIVersion

func (device *ParticulateMatterBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*ParticulateMatterBricklet) GetBootloaderMode

func (device *ParticulateMatterBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*ParticulateMatterBricklet) GetChipTemperature

func (device *ParticulateMatterBricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*ParticulateMatterBricklet) GetEnable

func (device *ParticulateMatterBricklet) GetEnable() (enable bool, err error)

Returns the state of the sensor as set by SetEnable.

func (*ParticulateMatterBricklet) GetIdentity

func (device *ParticulateMatterBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*ParticulateMatterBricklet) GetPMConcentration

func (device *ParticulateMatterBricklet) GetPMConcentration() (pm10 uint16, pm25 uint16, pm100 uint16, err error)

Returns the particulate matter concentration, broken down as:

* PM\ :sub:`1.0`\ , * PM\ :sub:`2.5`\ and * PM\ :sub:`10.0`\ .

If the sensor is disabled (see SetEnable) then the last known good values from the sensor are returned.

If you want to get the values periodically, it is recommended to use the RegisterPMConcentrationCallback callback. You can set the callback configuration with SetPMConcentrationCallbackConfiguration.

func (*ParticulateMatterBricklet) GetPMConcentrationCallbackConfiguration

func (device *ParticulateMatterBricklet) GetPMConcentrationCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetPMConcentrationCallbackConfiguration.

func (*ParticulateMatterBricklet) GetPMCount

func (device *ParticulateMatterBricklet) GetPMCount() (greater03um uint16, greater05um uint16, greater10um uint16, greater25um uint16, greater50um uint16, greater100um uint16, err error)

Returns the number of particulates in 100 ml of air, broken down by their diameter:

* greater 0.3µm, * greater 0.5µm, * greater 1.0µm, * greater 2.5µm, * greater 5.0µm and * greater 10.0µm.

If the sensor is disabled (see SetEnable) then the last known good value from the sensor is returned.

If you want to get the values periodically, it is recommended to use the RegisterPMCountCallback callback. You can set the callback configuration with SetPMCountCallbackConfiguration.

func (*ParticulateMatterBricklet) GetPMCountCallbackConfiguration

func (device *ParticulateMatterBricklet) GetPMCountCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetPMCountCallbackConfiguration.

func (*ParticulateMatterBricklet) GetResponseExpected

func (device *ParticulateMatterBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*ParticulateMatterBricklet) GetSPITFPErrorCount

func (device *ParticulateMatterBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*ParticulateMatterBricklet) GetSensorInfo

func (device *ParticulateMatterBricklet) GetSensorInfo() (sensorVersion uint8, lastErrorCode uint8, framingErrorCount uint8, checksumErrorCount uint8, err error)

Returns information about the sensor:

* the sensor version number, * the last error code reported by the sensor (0 means no error) and * the number of framing and checksum errors that occurred in the communication

with the sensor.

func (*ParticulateMatterBricklet) GetStatusLEDConfig

func (device *ParticulateMatterBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*ParticulateMatterBricklet) ReadUID

func (device *ParticulateMatterBricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*ParticulateMatterBricklet) RegisterPMConcentrationCallback

func (device *ParticulateMatterBricklet) RegisterPMConcentrationCallback(fn func(uint16, uint16, uint16)) uint64

This callback is triggered periodically according to the configuration set by SetPMConcentrationCallbackConfiguration.

The parameters are the same as GetPMConcentration.

func (*ParticulateMatterBricklet) RegisterPMCountCallback

func (device *ParticulateMatterBricklet) RegisterPMCountCallback(fn func(uint16, uint16, uint16, uint16, uint16, uint16)) uint64

This callback is triggered periodically according to the configuration set by SetPMCountCallbackConfiguration.

The parameters are the same as GetPMCount.

func (*ParticulateMatterBricklet) Reset

func (device *ParticulateMatterBricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*ParticulateMatterBricklet) SetBootloaderMode

func (device *ParticulateMatterBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*ParticulateMatterBricklet) SetEnable

func (device *ParticulateMatterBricklet) SetEnable(enable bool) (err error)

Enables/Disables the fan and the laser diode of the sensors. The sensor is enabled by default.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

func (*ParticulateMatterBricklet) SetPMConcentrationCallbackConfiguration

func (device *ParticulateMatterBricklet) SetPMConcentrationCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterPMConcentrationCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*ParticulateMatterBricklet) SetPMCountCallbackConfiguration

func (device *ParticulateMatterBricklet) SetPMCountCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterPMCountCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*ParticulateMatterBricklet) SetResponseExpected

func (device *ParticulateMatterBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

func (*ParticulateMatterBricklet) SetResponseExpectedAll

func (device *ParticulateMatterBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*ParticulateMatterBricklet) SetStatusLEDConfig

func (device *ParticulateMatterBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*ParticulateMatterBricklet) SetWriteFirmwarePointer

func (device *ParticulateMatterBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*ParticulateMatterBricklet) WriteFirmware

func (device *ParticulateMatterBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*ParticulateMatterBricklet) WriteUID

func (device *ParticulateMatterBricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)
Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
f or F : Jump to identifier