Contents¶
Overview¶
docs |
|
|---|---|
tests |
 |
package |
     |
Transfer tables for LMT8x Temperature Sensors.
LMT8x (LMT84, LMT85, LMT86, LMT87) are a series of analog temperature sensors made by Texus Instrument. These sensors can provide -50°C ~ 150°C with ±0.4°C accuracy. Although the output voltage is nearly linear to the temperature, it does have a slight umbrella parabolic shape. Therefore transfer tables are required to convert the voltage to the temperature.
Datasheets:
This package provides tranfer functions for LMT84, LMT85, LMT86, and LMT87 based on their transfer tables. These funcitons basically do a binary search through the transfer tables and return the match. If no match found, linear interpolation will be used to generate an approximate value.
Installation¶
pip install lmt8x
You can also install the in-development version with:
pip install https://github.com/charlee/python-lmt8x/archive/master.zip
Usage¶
lmt8x package provides functions lmt84_v2t, lmt85_v2t, lmt86_v2t, and lmt87_v2t for converting voltage to temperature.
input voltage must be in mV.
output temperature is in celsius.
from lmt8x import lmt87_v2t # or `lmt86_v2t`, `lmt85_v2t`, `lmt84_v2t`
# read voltage from sensors.
# v = read_sensor()
# convert v to temperature.
# the pamaeter must be in mV. Return value is in celsius.
temp = lmt87_v2t(v * 1000)
print('Temperature is %s C.' % temp)
Documentation¶
Development¶
To run all the tests run:
tox
Note, to combine the coverage data from all the tox environments run:
Windows |
set PYTEST_ADDOPTS=--cov-append
tox
|
|---|---|
Other |
PYTEST_ADDOPTS=--cov-append tox
|
Usage¶
lmt8x package provides functions lmt84_v2t, lmt85_v2t, lmt86_v2t, and lmt87_v2t for converting voltage to temperature.
input voltage must be in mV.
output temperature is in Celsius.
from lmt8x import lmt87_v2t # or `lmt86_v2t`, `lmt85_v2t`, `lmt84_v2t`
# read voltage from sensors.
# v = read_sensor()
# convert v to temperature.
# the pamaeter must be in mV. Return value is in celsius.
temp = lmt87_v2t(v * 1000)
print('Temperature is %s C.' % temp)
Reference¶
lmt8x¶
-
lmt8x.lmt84_v2t(v)[source]¶ Transfer function for LMT84.
- Parameters
v (float) – Voltage in mV.
- Returns
Temperature in Celsius.
- Return type
float
-
lmt8x.lmt85_v2t(v)[source]¶ Transfer function for LMT85.
- Parameters
v (float) – Voltage in mV.
- Returns
Temperature in Celsius.
- Return type
float
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Documentation improvements¶
LMT8x could always use more documentation, whether as part of the official LMT8x docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/charlee/python-lmt8x/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up python-lmt8x for local development:
Fork python-lmt8x (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:YOURGITHUBNAME/python-lmt8x.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes run all the checks and docs builder with tox one command:
toxCommit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
Include passing tests (run
tox) 1.Update documentation when there’s new API, functionality etc.
Add a note to
CHANGELOG.rstabout the changes.Add yourself to
AUTHORS.rst.
- 1
If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.
It will be slower though …
Tips¶
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel:
tox -p auto
Authors¶
Charlee Li - https://charlee.li