Package com.tinkerforge
Class BrickletParticulateMatter
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletParticulateMatter
-
public class BrickletParticulateMatter extends Device
Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletParticulateMatter.PMConcentration
class
BrickletParticulateMatter.PMConcentrationCallbackConfiguration
static interface
BrickletParticulateMatter.PMConcentrationListener
This listener is triggered periodically according to the configuration set bysetPMConcentrationCallbackConfiguration(long, boolean)
.class
BrickletParticulateMatter.PMCount
class
BrickletParticulateMatter.PMCountCallbackConfiguration
static interface
BrickletParticulateMatter.PMCountListener
This listener is triggered periodically according to the configuration set bysetPMCountCallbackConfiguration(long, boolean)
.class
BrickletParticulateMatter.SensorInfo
class
BrickletParticulateMatter.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletParticulateMatter(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
Adds a PMConcentration listener.void
addPMCountListener(BrickletParticulateMatter.PMCountListener listener)
Adds a PMCount listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.boolean
getEnable()
Returns the state of the sensor as set bysetEnable(boolean)
.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.BrickletParticulateMatter.PMConcentration
getPMConcentration()
Returns the particulate matter concentration, broken down as: * PM\ :sub:`1.0`\ , * PM\ :sub:`2.5`\ and * PM\ :sub:`10.0`\ .BrickletParticulateMatter.PMConcentrationCallbackConfiguration
getPMConcentrationCallbackConfiguration()
Returns the listener configuration as set bysetPMConcentrationCallbackConfiguration(long, boolean)
.BrickletParticulateMatter.PMCount
getPMCount()
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.BrickletParticulateMatter.PMCountCallbackConfiguration
getPMCountCallbackConfiguration()
Returns the listener configuration as set bysetPMCountCallbackConfiguration(long, boolean)
.BrickletParticulateMatter.SensorInfo
getSensorInfo()
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.BrickletParticulateMatter.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removePMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
Removes a PMConcentration listener.void
removePMCountListener(BrickletParticulateMatter.PMCountListener listener)
Removes a PMCount listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setEnable(boolean enable)
Enables/Disables the fan and the laser diode of the sensors.void
setPMConcentrationCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletParticulateMatter.PMConcentrationListener
listener is triggered periodically.void
setPMCountCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletParticulateMatter.PMCountListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_PM_CONCENTRATION
public static final byte FUNCTION_GET_PM_CONCENTRATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_PM_COUNT
public static final byte FUNCTION_GET_PM_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_ENABLE
public static final byte FUNCTION_SET_ENABLE
- See Also:
- Constant Field Values
-
FUNCTION_GET_ENABLE
public static final byte FUNCTION_GET_ENABLE
- See Also:
- Constant Field Values
-
FUNCTION_GET_SENSOR_INFO
public static final byte FUNCTION_GET_SENSOR_INFO
- See Also:
- Constant Field Values
-
FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletParticulateMatter
public BrickletParticulateMatter(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getPMConcentration
public BrickletParticulateMatter.PMConcentration getPMConcentration() throws TinkerforgeException
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 (seesetEnable(boolean)
) then the last known good values from the sensor are returned. If you want to get the values periodically, it is recommended to use theBrickletParticulateMatter.PMConcentrationListener
listener. You can set the listener configuration withsetPMConcentrationCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
getPMCount
public BrickletParticulateMatter.PMCount getPMCount() throws TinkerforgeException
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 (seesetEnable(boolean)
) then the last known good value from the sensor is returned. If you want to get the values periodically, it is recommended to use theBrickletParticulateMatter.PMCountListener
listener. You can set the listener configuration withsetPMCountCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
setEnable
public void setEnable(boolean enable) throws TinkerforgeException
Enables/Disables the fan and the laser diode of the sensors. 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.- Throws:
TinkerforgeException
-
getEnable
public boolean getEnable() throws TinkerforgeException
Returns the state of the sensor as set bysetEnable(boolean)
.- Throws:
TinkerforgeException
-
getSensorInfo
public BrickletParticulateMatter.SensorInfo getSensorInfo() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setPMConcentrationCallbackConfiguration
public void setPMConcentrationCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletParticulateMatter.PMConcentrationListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.- Throws:
TinkerforgeException
-
getPMConcentrationCallbackConfiguration
public BrickletParticulateMatter.PMConcentrationCallbackConfiguration getPMConcentrationCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetPMConcentrationCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
setPMCountCallbackConfiguration
public void setPMCountCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletParticulateMatter.PMCountListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.- Throws:
TinkerforgeException
-
getPMCountCallbackConfiguration
public BrickletParticulateMatter.PMCountCallbackConfiguration getPMCountCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetPMCountCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletParticulateMatter.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. 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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature 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.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addPMConcentrationListener
public void addPMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
Adds a PMConcentration listener.
-
removePMConcentrationListener
public void removePMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
Removes a PMConcentration listener.
-
addPMCountListener
public void addPMCountListener(BrickletParticulateMatter.PMCountListener listener)
Adds a PMCount listener.
-
removePMCountListener
public void removePMCountListener(BrickletParticulateMatter.PMCountListener listener)
Removes a PMCount listener.
-
-