https://github.com/nebrius/raspi-onewire
Provides access to 1-Wire on the Raspberry Pi from Node.js
https://github.com/nebrius/raspi-onewire
Last synced: 3 months ago
JSON representation
Provides access to 1-Wire on the Raspberry Pi from Node.js
- Host: GitHub
- URL: https://github.com/nebrius/raspi-onewire
- Owner: nebrius
- License: mit
- Created: 2017-09-14T17:14:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-17T01:32:09.000Z (over 8 years ago)
- Last Synced: 2025-03-26T13:39:15.406Z (over 1 year ago)
- Language: TypeScript
- Size: 15.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Raspi OneWire
=============
[](https://gitter.im/nebrius/raspi-io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Raspi OneWire is part of the [Raspi.js suite of libraries](https://github.com/nebrius/raspi) that provides access to a software emulated 1-wire interface on a Raspberry Pi.
If you have a bug report, feature request, or wish to contribute code, please be sure to check out the [Raspi IO Contributing Guide](https://github.com/nebrius/raspi-io/blob/master/CONTRIBUTING.md).
## System Requirements
- Raspberry Pi Model B Rev 1 or newer (sorry Model A users)
- Raspbian Jessie or newer
- [Node-RED](http://nodered.org/) works, but can be finicky and difficult to debug.
- See https://github.com/nebrius/raspi-io/issues/24 for more info about support for other OSes
- Node 4.0.0 or newer
Detailed instructions for getting a Raspberry Pi ready for NodeBots, including how to install Node.js, can be found in the [wiki](https://github.com/nebrius/raspi-io/wiki/Getting-a-Raspberry-Pi-ready-for-NodeBots)
## Installation
First, be sure that you have installed [Raspi.js](https://github.com/nebrius/raspi).
Install with npm:
```Shell
npm install raspi-onewire
```
**Note:** this project is written in [TypeScript](http://www.typescriptlang.org/) and includes type definitions in the package.json file. This means that if you want to use it from TypeScript, you don't need to install a separate @types module.
## Example Usage
In TypeScript/ES2015+:
```JavaScript
import { init } from 'raspi';
import { OneWire } from 'raspi-onewire';
init(() => {
const bus = new OneWire();
bus.searchForDevices((err, devices) => {
bus.readAllAvailable(devices[0], (err, data) => {
console.log(data);
});
});
});
```
In JavaScript/ES5:
```JavaScript
const raspi = require('raspi');
const OneWire = require('raspi-onewire').OneWire;
raspi.init(() => {
const bus = new OneWire();
bus.searchForDevices((err, devices) => {
bus.readAllAvailable(devices[0], (err, data) => {
console.log(data);
});
});
});
```
## API
### new OneWire()
Instantiates a new OneWire instance. Note that OneWire only works on pin `GPIO4`.
_Arguments_: None
### Instance Methods
#### searchForDevices(cb)
Searches for all devices currently attached to the bus.
_Arguments_:
Argument
Type
Description
cb
Function
The callback to call with the results.
Argument
Type
Description
err
String | Error | undefined
The error, if one occurred, else undefined
devices
undefined | Number[][]
If no error occurred, an array of zero or more device IDs
_Returns_: None
#### read(deviceID, numBytesToRead, cb)
Reads the specified number of bytes from the device specified.
_Arguments_:
Argument
Type
Description
deviceID
Number[]
The ID of the device, as returned from searchForDevices.
numBytesToRead
Number
The number of bytes to read.
cb
Function
The callback to call with the read data.
Argument
Type
Description
err
String | Error | undefined
The error, if one occurred, else undefined
data
undefined | Buffer
If no error occurred, the read data. The number of bytes read may be less than numBytesToRead if there are not that many bytes to read at the time of the call.
_Returns_: None
#### readAllAvailable(deviceID, cb)
Reads all available bytes from the device specified.
_Arguments_:
Argument
Type
Description
deviceID
Number[]
The ID of the device, as returned from searchForDevices.
cb
Function
The callback to call with the read data.
Argument
Type
Description
err
String | Error | undefined
The error, if one occurred, else undefined
data
undefined | Buffer
If no error occurred, the read data.
_Returns_: None
License
=======
The MIT License (MIT)
Copyright (c) 2014-2017 Bryan Hughes
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.