[UNMAINTAINED] JS library for the si7005 temperature and humidity sensor.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
test
.gitignore
COPYRIGHT
LICENSE-APACHE
LICENSE-MIT
README.md
index.js
package.json

README.md

[UNMAINTAINED] This library does not have a maintainer. The source code and repository will be kept at this URL indefinitely. If you'd like to help maintain this codebase, create an issue on this repo explaining why you'd like to become a maintainer and tag @tessel/maintainers in the body.

Climate

Code of Conduct

Driver for the climate-si7005 Tessel climate module. The hardware documentation for this module can be found here.

A port of @jjalling's Si7005-B-GM Arduino library to JS.

If you run into any issues you can ask for support on the Climate Module Forums.

Hardware overview/setup

The module may come with a protective white cover over the sensor, as shown in the image below. This cover is permeable and does not need to be removed before use. If the protective cover is removed, avoid touching, poking, or dirtying the exposed silicon die.

Climate module with protective cover still in place

There are multiple versions of this module. In the picture above, you can see that it says "climate-si7005", but yours may say something different, like "climate-si7020". In that case, you need to use "climate-si7020" in places where these docs say "climate-si7005".

Installation

npm install climate-si7005

# If your module says `climate-si7020` on it, `npm install` that instead:
# npm install climate-si7020

Example

/*********************************************
This basic climate example logs a stream
of temperature and humidity to the console.
*********************************************/

var tessel = require('tessel');

// !!! Change this to require('climate-si7020') if that's what's written on your module.
var climatelib = require('climate-si7005');

var climate = climatelib.use(tessel.port['A']);

climate.on('ready', function () {
  console.log('Connected to si7005');

  // Loop forever
  setImmediate(function loop () {
    climate.readTemperature('f', function (err, temp) {
      climate.readHumidity(function (err, humid) {
        console.log('Degrees:', temp.toFixed(4) + 'F', 'Humidity:', humid.toFixed(4) + '%RH');
        setTimeout(loop, 300);
      });
    });
  });
});

climate.on('error', function(err) {
  console.log('error connecting module', err);
});
setInterval(function(){}, 20000);

Methods

# climate.use ( interface[, csn] ) Takes in the port bank that the module is connected to. Returns the Climate object.

# climate.readTemperature ( [format,] callback(err, temp) )
Returns the temperature in degrees Celcius or Fahrenheit.

# climate.readHumidity ( callback(err, humidity) )
Returns the relative humidity.

# climate.setHeater ( bool[, callback(err)] )

Sets the HEAT config register. The heater evaporates any moisture that may have condensed on the sensor in high humidty environments. Enabling the heater will increase the accuracy of humidity measurements but will interfere with temperature measurement.

According to section 5.1.4 of the datasheet Turning on the heater will reduce the tendency of the humidity sensor to accumulate an offset due to “memory” of sustained high humidity conditions. When the heater is enabled, the reading of the on-chip temperature sensor will be affected (increased).

# climate.setFastMeasure ( bool[, callback(err)] )
Sets the FAST config register.

According to section 5.1.3 of the datasheet Fast mode reduces the total power consumed during a conversion or the average power consumed by the Si7005 when making periodic conversions. It also reduces the resolution of the measurements.

| Normal | Fast --- | --- | --- converstion time | 35ms | 18ms temp resolution | 14 bit | 13 bit humidity resolution | 12 bit | 11 bit

Events

# climate.on ( 'ready' )
Emitted when upon first successful communication between the Tessel and the module.

# climate.on ( 'temperature'[,callback(temperature, temp_type)] )
Emitted when temperature data is received. Internal to the readTemperature method, useful when another module is triggered by climate data.

# climate.on ( 'humidity'[,callback(humidity)] )
Emitted when humidity data is received. Internal to the readHumidity method, useful when another module is triggered by climate data.

###Further Examples

  • Climate Events. This basic example demonstrates how the climate module emits events for temperature.
  • Climate Heater. This example demonstates the climate module's built in heater and how it effects temperature and humidity readings.

References

License

MIT or Apache 2.0, at your option