mirror of
https://github.com/nodemcu/nodemcu-firmware.git
synced 2025-01-30 21:12:55 +08:00
9d11543fa9
* Hdc1080 Module Add * for Float/Integer Build fixes * disable module for default * document fix * Deprecate init() in favor of setup() * Fix grammar and code sample * Deprecate init() in favor of setup() * Update hdc1080.md * Update hdc1080.md * Mini fix * Update user_modules.h
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# HDC1080 Module
|
|
| Since | Origin / Contributor | Maintainer | Source |
|
|
| :----- | :-------------------- | :---------- | :------ |
|
|
| 2017-04-01 | [Metin KOC](https://github.com/saucompeng) | [Metin KOC](https://github.com/saucompeng) | [hdc1080.c](../../../app/modules/hdc1080.c)|
|
|
|
|
|
|
This module provides access to the [HDC1080](http://www.ti.com/product/HDC1080) low power, high accuracy digital humidity sensor with temperature sensor.
|
|
|
|
## hdc1080.read()
|
|
Samples the sensor then returns temperature and humidity value.
|
|
|
|
#### Syntax
|
|
`hdc1080.read()`
|
|
|
|
#### Returns
|
|
Temperature data in centigrade and humidity data in percentage (0-100) (integer/float)
|
|
|
|
#### Example
|
|
```lua
|
|
local sda, scl = 1, 2
|
|
i2c.setup(0, sda, scl, i2c.SLOW) -- call i2c.setup() only once
|
|
hdc1080.setup()
|
|
local temperature,humidity = hdc1080.read()
|
|
print(temperature)
|
|
print(humidity)
|
|
```
|
|
|
|
## hdc1080.setup()
|
|
Initializes the module.
|
|
|
|
#### Syntax
|
|
`hdc1080.setup()`
|
|
|
|
#### Parameters
|
|
- None
|
|
|
|
#### Returns
|
|
`nil`
|
|
|
|
|
|
## hdc1080.init(sda,scl)
|
|
Initializes the module and sets the pin configuration.
|
|
|
|
!!! attention
|
|
|
|
This function is deprecated and will be removed in upcoming releases. Use `hdc1080.setup()` instead.
|
|
|
|
#### Syntax
|
|
`hdc1080.init(sda, scl)`
|
|
|
|
#### Parameters
|
|
- `sda` data pin
|
|
- `scl` clock pin
|
|
|
|
#### Returns
|
|
`nil`
|