UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. Back to index page.
SparkFun sensor images provided under CC BY-NC-SA-3.0.

T8100 Class

Module: t8100

This module implements support for the Amphenol Telaire Ventostat T8100 Ventilation Controller with BACnet interface. It may also support the T8200 and T8300 models, but they have not been tested.
The Telaire Ventostat T8100 reports Temperature , Humidity and CO2 concentrations. It supports an optional relay with a settable trigger point. The unit this driver was tested under did not support the optional relay. The temperature range supported is 0-50C, humidity is 0-100% non-condensing, and CO2 range is appoximately 0-2000 PPM for the T8100 . Other sensors in this family support wider ranges.
This module was developed using the upm::BACNETMSTP library, based on libbacnet-stack 0.8.3. Both libbacnet 0.8.3 and the upm::BACNETMSTP libraries must be present in order to build this module.
It was connected using an RS232->RS485 interface. You cannot use the built in MCU TTL UART pins for accessing this device b you must use a full Serial RS232->RS485 or USB-RS485 interface connected via USB.

Methods

T8100

(
  • targetDeviceObjectID
)
Number

T8100 constructor

Parameters:

  • targetDeviceObjectID Number

    the unique Instance ID of the Device Object. This number is used to uniquely identify devices on the BACnet network, and ranges from 1 to 4194302. This is not the device's MAC address, though on some devices, the MAC address may be used as part of this number. On the T8100 , this number is 568XXX, where XXX are the 3 digits of the set MAC address. The MAC address is configured via DIP switches within the device.

Returns:

Number:

update

()

Read current values from the sensor and update internal stored values for temperature, humidity, CO2 concentration and relay state. This method must be called prior to querying any of the aforementioned values.

getHumidity

() Number

Get the current relative humidity. update() must have been called prior to calling this method.

Returns:

Number:

The last humidity reading

getCO2

() Number

Get the current CO2 concentration in Parts per Million (PPM). update() must have been called prior to calling this method.

Returns:

Number:

The last CO2 reading

getTemperature

(
  • fahrenheit
)
Number

Get the current temperature. update() must have been called prior to calling this method.

Parameters:

  • fahrenheit Boolean

    true to return the temperature in degrees fahrenheit, false to return the temperature in degrees celsius. The default is false (degrees Celsius).

Returns:

Number:

The last temperature reading in Celsius or Fahrenheit.

getRelayState

() Boolean

Return the current state of the relay. This function will always return false if the relay option is not installed. update() must have been called prior to calling this method.

Returns:

Boolean:

true if the relay is active, false if inactive.

setTemperatureScale

(
  • fahrenheit
)

Set the device temperature scale to Celsius of Fahrenheit. For devices with an LCD display, this will affect which scale is displayed. When changing the scale, it may take several seconds for the setting to take effect.

Parameters:

  • fahrenheit Boolean

    true to set the scale to fahrenheit, false for celsius.

getTemperatureScale

() Boolean

Get the device temperature scale.

Returns:

Boolean:

true if scale is fahrenheit, false for celsius.

getTemperatureOffset

() Number

Get the current temperature offset.

Returns:

Number:

The configured temperature offset.

setTemperatureOffset

(
  • value
)

Set the device temperature offset. The offset is applied by the device internally to the temperature reading. The offset must always be specified in degrees Celsius. Valid values must be between -50 and 50.

Parameters:

  • value Number

    The temperature offset to configure.

getHumidityOffset

() Number

Get the current humidity offset.

Returns:

Number:

The configured humidity offset.

setHumidityOffset

(
  • value
)

Set the device humidity offset. The offset is applied by the device internally to the humidity reading. Valid values must be between -100 and 100.

Parameters:

  • value Number

    The humidity offset to configure.

getRelaySetPoint

() Number

Return the current relay set point (in PPM). This set point is the CO2 concentration point in PPM that causes the relay to trigger.

Returns:

Number:

The relay set point value.

setRelaySetPoint

(
  • value
)

Set the relay set point in PPM. This set point is the CO2 concentration point in PPM that causes the relay to trigger. Valid values are between 0-65535.

Parameters:

  • value Number

    The desired relay set point value.

getRelayHysteresis

() Number

Return the current relay hysteresis.

Returns:

Number:

The relay hysteresis value.

setRelayHysteresis

(
  • value
)

Set the relay hysteresis. Valid values are between 0-65535.

Parameters:

  • value Number

    The desired relay set point value.

getElevation

() Number

Return the current elevation setting (in meters).

Returns:

Number:

The current elevation setting.

setElevation

(
  • value
)

Set the elevation setting in meters. Valid values are between 0-65535.

Parameters:

  • value Number

    The desired elevation setting in meters.

getCalibrationSinglePoint

() Number

Return the current calibration single point value (in PPM).

Returns:

Number:

The current calibration single point value.

setCalibrationSinglePoint

(
  • value
)

Set the calibration single point value in PPM. Valid values are between 0-65535.

Parameters:

  • value Number

    The desired calibration single point value in PPM.

getBaudRate

() Number

Return the current baud rate.

Returns:

Number:

The current baud rate.

getMACAddress

() Number

Return the current MAC address. The MAC address is configured via DIP switches within the device.

Returns:

Number:

The current MAC address.

getABCLogicState

() Boolean

Return the current ABC (Automatic Background Calibration) logic state. See the datasheet for details.

Returns:

Boolean:

The current ABC logic state.

setABCLogicState

(
  • value
)

Set the ABC (Automatic Background Calibration) logic state. Valid values are true for ON, false for OFF.

Parameters:

  • value Boolean

    The desired ABC logic state.

getABCLogicReset

() Boolean

Return the current ABC (Automatic Background Calibration) reset state. See the datasheet for details.

Returns:

Boolean:

The current ABC reset state.

setABCLogicReset

(
  • value
)

Set the ABC (Automatic Background Calibration) reset state. Valid values are true for Reset, false for Normal.

Parameters:

  • value Boolean

    The desired ABC reset state.

getCO2Calibration

() Boolean

Return the current CO2 calibration state. See the datasheet for details.

Returns:

Boolean:

The current CO2 calibration state.

setCO2Calibration

(
  • value
)

Set the CO2 calibration state. Valid values are true for Calibrate, false for Normal.

Parameters:

  • value Boolean

    The desired ABC reset state.

Properties

AV_Temperature_Offset

Enum ANALOG_VALUES_T

AV_RH_Offset

Enum ANALOG_VALUES_T

AV_Relay_Set_Point

Enum ANALOG_VALUES_T

AV_Relay_Hysteresis

Enum ANALOG_VALUES_T

AV_Elevation

Enum ANALOG_VALUES_T

AV_Calibration_Single_Point

Enum ANALOG_VALUES_T

AV_Baud_Rate

Enum ANALOG_VALUES_T

AV_MAC_Address

Enum ANALOG_VALUES_T

AI_CO2

Enum ANALOG_INPUTS_T

AI_Relative_Humidity

Enum ANALOG_INPUTS_T

AI_Temperature_ChipCap

Enum ANALOG_INPUTS_T

AI_Temperature_Thermistor

Enum ANALOG_INPUTS_T

BV_Temperature_Units

Enum BINARY_VALUES_T

BV_ABC_Logic_State

Enum BINARY_VALUES_T

BV_ABC_Logic_Reset

Enum BINARY_VALUES_T

BV_CO2_Calibration

Enum BINARY_VALUES_T

BI_Relay_State

Enum BINARY_INPUTS_T