Skip to content

Commit ee2ea5a

Browse files
Update README.md
1 parent 61fb1c8 commit ee2ea5a

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

Diff for: README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
#Thermistor
22

3-
This class makes it simple for an imp to read an NTC (“Negative Temperature Coefficient”) thermistor and determine the temperature. Thermistors are essentially temperature-dependent resistors. To use as a thermometer, a thermistor is used as half of a resistive divider, where the voltage across the full divider is known. The Imp then reads the voltage at the center of the divider to determine the ratio of resistance of the thermistor and the bias resistor (also the nominal resistance of the thermistor), [from which the temperature can be derived](http://en.wikipedia.org/wiki/Thermistor).
3+
This class makes it simple for an imp to read an NTC (“Negative Temperature Coefficient”) thermistor and determine the temperature. Thermistors are essentially temperature-dependent resistors. To use as a thermometer, a thermistor is used as half of a resistive divider, where the voltage across the full divider is known. The imp then reads the voltage at the center of the divider to determine the ratio of resistance of the thermistor and the bias resistor (also the nominal resistance of the thermistor), [from which the temperature can be derived](http://en.wikipedia.org/wiki/Thermistor).
44

55
**To add this library to your project, add** `#require "Thermistor.class.nut:2.0.0"` **to the top of your device code**
66

77
## Hardware
88

99
A resistive divider can be formed with the thermistor on the top or the bottom; this class allows for either configuration. The top of the divider should be connected to the same rail as an imp’s V<sub>DDA</sub> pin (or V<sub>DD</sub> pin, in the case of the imp001, as V<sub>DD</sub> and V<sub>DDA</sub> are internally connected). The bottom of the divider should be connected to ground.
1010

11-
The resistance of the bias resistor in the voltage divider should be equal to the nominal resistance of the thermistor (the resistance at T0). This simplifies the temperature calculation and allows the largest dynamic range.
11+
The resistance of the bias resistor in the voltage divider should be equal to the nominal resistance of the thermistor (the resistance at T0). This simplifies the temperature calculation and allows the largest dynamic range.
1212

13-
The center of the divider must be connected to a pin capable of analog input. On the imp001, any pin can be used as an analog input. On the imp002 or imp003, only some pins can be configured this way, so check the [Imp Pin Mux chart](http://electricimp.com/docs/hardware/imp/pinmux/).
13+
The center of the divider must be connected to a pin capable of analog input. On the imp001, any pin can be used as an analog input. On the imp002, imp003 and imp004m, only some pins can be configured this way, so check the [Imp Pin Mux chart](http://electricimp.com/docs/hardware/imp/pinmux/). The imp005 does not support analog input.
1414

1515
## Class Usage
1616

17-
### Constructor: Thermistor(pin, b_therm, t0_therm, [points], [high_side_therm])
17+
### Constructor: Thermistor(*pin, b_therm, t0_therm[, points][, high_side_therm]*)
1818

19-
The thermistor class takes three to five parameters (three required, two optional):
19+
The Thermistor class takes three to five parameters. Three are required, two are optional:
2020

2121
| Parameter Name | Description | Optional/Required |
2222
|----------------|-------------|-------------------|
@@ -31,7 +31,7 @@ The ß and T0 parameters are all available on the thermistor datasheet:
3131
| Parameter | Meaning |
3232
|-----------|---------|
3333
| ß | Characteristic of the thermistor. Most thermistors have many ß values listed, for various temperature ranges. Choose the value for the temperature range you will be operating in. |
34-
| T0 | Temperature at which the nominal resistance (R) of the thermistor is measured. Typically room temperature (~25ºC) |
34+
| T0 | Temperature at which the nominal resistance (R) of the thermistor is measured. Typically room temperature (~25&deg;C) |
3535

3636
```squirrel
3737
const b_therm = 3988;
@@ -66,4 +66,3 @@ server.log(kelvin);
6666
## License
6767

6868
Thermistor is licensed under [MIT License](./LICENSE).
69-

0 commit comments

Comments
 (0)