diff --git a/docs/en/modules/ds18b20.md b/docs/en/modules/ds18b20.md index c3d81b6f..ed15ff78 100644 --- a/docs/en/modules/ds18b20.md +++ b/docs/en/modules/ds18b20.md @@ -3,7 +3,7 @@ | :----- | :-------------------- | :---------- | :------ | | 2017-06-11 | [fetchbot](https://github.com/fetchbot) | [fetchbot](https://github.com/fetchbot) | [ds18b20.c](../../../app/modules/ds18b20.c)| -This module provides access to the DS18B20 1-Wire digital thermometer. +This module provides access to the DS18B20 1-Wire digital thermometer. Note that NodeMCU offers both a C module (this one) and [a Lua module for this sensor](https://github.com/nodemcu/nodemcu-firmware/tree/dev/lua_modules/ds18b20). See [#2003](https://github.com/nodemcu/nodemcu-firmware/pull/2003) for a discussion on the respective merits of them. ## ds18b20.read() Issues a temperature conversion of all connected sensors on the onewire bus and returns the measurment results after a conversion delay in a callback function. diff --git a/lua_modules/ds18b20/README.md b/lua_modules/ds18b20/README.md index bd122cf7..deb8a683 100644 --- a/lua_modules/ds18b20/README.md +++ b/lua_modules/ds18b20/README.md @@ -1,4 +1,7 @@ # DS18B20 Module + +This is a Lua module for the DS18B20 1-Wire digital thermometer. Note that NodeMCU offers both a Lua module (this one) and [a C module for this sensor](http://nodemcu.readthedocs.io/en/latest/en/modules/ds18b20/). See [#2003](https://github.com/nodemcu/nodemcu-firmware/pull/2003) for a discussion on the respective merits of them. + ## Require ```lua ds18b20 = require("ds18b20") @@ -8,7 +11,6 @@ ds18b20 = require("ds18b20") ds18b20 = nil package.loaded["ds18b20"]=nil ``` - # Methods