OneWire-UART documentation!¶
OneWire-UART is lightweight, platform independent library for Onewire protocol for embedded systems.
Features¶
Written in ANSI C99
Platform independent, uses custom low-level layer for device drivers
1-Wire protocol fits UART specifications at
9600
and115200
baudsHardware is responsible for timing characteristics * Allows DMA on the high-performance microcontrollers
Different device drivers included * DS18x20 temperature sensor is natively supported
Works with operating system due to hardware timing management * Separate thread-safe API is available
User friendly MIT license
Requirements¶
C compiler
Platform dependant drivers
Few kB of volatile memory
Contribute¶
We always welcome new contributors. To be as efficient as possible, we recommend:
Fork Github repository
Respect C style & coding rules used by the library
Make a pull request to
develop
branch with new features or bug fixes
Alternatively you may:
Report a bug
Ask for a feature request
License¶
Copyright (c) 2019 Tilen MAJERLE
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.