Class BrickletCO2V2


  • public class BrickletCO2V2
    extends Device
    Measures CO2 concentration, temperature and humidity
    • Field Detail

      • DEVICE_DISPLAY_NAME

        public static final java.lang.String DEVICE_DISPLAY_NAME
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_VALUES

        public static final byte FUNCTION_GET_ALL_VALUES
        See Also:
        Constant Field Values
      • FUNCTION_SET_AIR_PRESSURE

        public static final byte FUNCTION_SET_AIR_PRESSURE
        See Also:
        Constant Field Values
      • FUNCTION_GET_AIR_PRESSURE

        public static final byte FUNCTION_GET_AIR_PRESSURE
        See Also:
        Constant Field Values
      • FUNCTION_SET_TEMPERATURE_OFFSET

        public static final byte FUNCTION_SET_TEMPERATURE_OFFSET
        See Also:
        Constant Field Values
      • FUNCTION_GET_TEMPERATURE_OFFSET

        public static final byte FUNCTION_GET_TEMPERATURE_OFFSET
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_CO2_CONCENTRATION

        public static final byte FUNCTION_GET_CO2_CONCENTRATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_TEMPERATURE

        public static final byte FUNCTION_GET_TEMPERATURE
        See Also:
        Constant Field Values
      • FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_HUMIDITY_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
      • THRESHOLD_OPTION_OUTSIDE

        public static final char THRESHOLD_OPTION_OUTSIDE
        See Also:
        Constant Field Values
      • THRESHOLD_OPTION_INSIDE

        public static final char THRESHOLD_OPTION_INSIDE
        See Also:
        Constant Field Values
      • THRESHOLD_OPTION_SMALLER

        public static final char THRESHOLD_OPTION_SMALLER
        See Also:
        Constant Field Values
      • THRESHOLD_OPTION_GREATER

        public static final char THRESHOLD_OPTION_GREATER
        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_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_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

      • BrickletCO2V2

        public BrickletCO2V2​(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

      • setAirPressure

        public void setAirPressure​(int airPressure)
                            throws TinkerforgeException
        The CO2 concentration depends (among other things) on the ambient air pressure. To increase the accuracy of the CO2 Bricklet 2.0 you can set the current air pressure. You use the :ref:`Barometer Bricklet 2.0 <barometer_v2_bricklet>` or the :ref:`Air Quality Bricklet <air_quality_bricklet>` to get the current air pressure. By default air pressure compensation is disabled. Once you set a value it will be used for compensation. You can turn the compensation off again by setting the value to 0. It is sufficient to update the value every few minutes.
        Throws:
        TinkerforgeException
      • setTemperatureOffset

        public void setTemperatureOffset​(int offset)
                                  throws TinkerforgeException
        Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C. If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure. We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset. This temperature offset is used to calculate the relative humidity and CO2 concentration. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements. It is sufficient to set the temperature offset once. The offset is saved in non-volatile memory and is applied again after a power loss.
        Throws:
        TinkerforgeException
      • setAllValuesCallbackConfiguration

        public void setAllValuesCallbackConfiguration​(long period,
                                                      boolean valueHasToChange)
                                               throws TinkerforgeException
        The period is the period with which the BrickletCO2V2.AllValuesListener 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 at least one of the values has changed. If the values 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
      • setCO2ConcentrationCallbackConfiguration

        public void setCO2ConcentrationCallbackConfiguration​(long period,
                                                             boolean valueHasToChange,
                                                             char option,
                                                             int min,
                                                             int max)
                                                      throws TinkerforgeException
        The period is the period with which the BrickletCO2V2.CO2ConcentrationListener 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. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for the BrickletCO2V2.CO2ConcentrationListener listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.
        Throws:
        TinkerforgeException
      • setTemperatureCallbackConfiguration

        public void setTemperatureCallbackConfiguration​(long period,
                                                        boolean valueHasToChange,
                                                        char option,
                                                        int min,
                                                        int max)
                                                 throws TinkerforgeException
        The period is the period with which the BrickletCO2V2.TemperatureListener 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. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for the BrickletCO2V2.TemperatureListener listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.
        Throws:
        TinkerforgeException
      • setHumidityCallbackConfiguration

        public void setHumidityCallbackConfiguration​(long period,
                                                     boolean valueHasToChange,
                                                     char option,
                                                     int min,
                                                     int max)
                                              throws TinkerforgeException
        The period is the period with which the BrickletCO2V2.HumidityListener 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. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for the BrickletCO2V2.HumidityListener listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletCO2V2.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
      • setWriteFirmwarePointer

        public void setWriteFirmwarePointer​(long pointer)
                                     throws TinkerforgeException
        Sets the firmware pointer for 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.
        Throws:
        TinkerforgeException
      • writeFirmware

        public int writeFirmware​(int[] data)
                          throws TinkerforgeException
        Writes 64 Bytes of firmware at the position as written by 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.
        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
      • 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
      • 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 class Device
        Throws:
        TinkerforgeException