public class BrickletParticulateMatter extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletParticulateMatter.PMConcentration |
class |
BrickletParticulateMatter.PMConcentrationCallbackConfiguration |
static interface |
BrickletParticulateMatter.PMConcentrationListener
This listener is triggered periodically according to the configuration set by
setPMConcentrationCallbackConfiguration(long, boolean) . |
class |
BrickletParticulateMatter.PMCount |
class |
BrickletParticulateMatter.PMCountCallbackConfiguration |
static interface |
BrickletParticulateMatter.PMCountListener
This listener is triggered periodically according to the configuration set by
setPMCountCallbackConfiguration(long, boolean) . |
class |
BrickletParticulateMatter.SensorInfo |
class |
BrickletParticulateMatter.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletParticulateMatter(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
boolean |
getEnable()
Returns the state of the sensor as set by
setEnable(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 by
setPMConcentrationCallbackConfiguration(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 by
setPMCountCallbackConfiguration(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 by
setStatusLEDConfig(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 the
BrickletParticulateMatter.PMConcentrationListener
listener is triggered periodically. |
void |
setPMCountCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletParticulateMatter.PMCountListener listener
is triggered periodically. |
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_PM_CONCENTRATION
public static final byte FUNCTION_GET_PM_COUNT
public static final byte FUNCTION_SET_ENABLE
public static final byte FUNCTION_GET_ENABLE
public static final byte FUNCTION_GET_SENSOR_INFO
public static final byte FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletParticulateMatter(java.lang.String uid, IPConnection ipcon)
public BrickletParticulateMatter.PMConcentration getPMConcentration() throws TinkerforgeException
setEnable(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 the
BrickletParticulateMatter.PMConcentrationListener
listener. You can set the listener configuration
with setPMConcentrationCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletParticulateMatter.PMCount getPMCount() throws TinkerforgeException
setEnable(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 the
BrickletParticulateMatter.PMCountListener
listener. You can set the listener configuration
with setPMCountCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setEnable(boolean enable) throws TinkerforgeException
TinkerforgeException
public boolean getEnable() throws TinkerforgeException
setEnable(boolean)
.TinkerforgeException
public BrickletParticulateMatter.SensorInfo getSensorInfo() throws TinkerforgeException
TinkerforgeException
public void setPMConcentrationCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletParticulateMatter.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.TinkerforgeException
public BrickletParticulateMatter.PMConcentrationCallbackConfiguration getPMConcentrationCallbackConfiguration() throws TinkerforgeException
setPMConcentrationCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setPMCountCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletParticulateMatter.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.TinkerforgeException
public BrickletParticulateMatter.PMCountCallbackConfiguration getPMCountCallbackConfiguration() throws TinkerforgeException
setPMCountCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletParticulateMatter.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addPMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
public void removePMConcentrationListener(BrickletParticulateMatter.PMConcentrationListener listener)
public void addPMCountListener(BrickletParticulateMatter.PMCountListener listener)
public void removePMCountListener(BrickletParticulateMatter.PMCountListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.