Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lwmqn/smartobject-watchify
An extension to make a Smart Object instance listenable to its resource changes
https://github.com/lwmqn/smartobject-watchify
smartobject
Last synced: about 22 hours ago
JSON representation
An extension to make a Smart Object instance listenable to its resource changes
- Host: GitHub
- URL: https://github.com/lwmqn/smartobject-watchify
- Owner: lwmqn
- License: mit
- Created: 2017-03-09T08:29:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-23T20:50:59.000Z (about 5 years ago)
- Last Synced: 2024-12-25T23:33:13.357Z (12 days ago)
- Topics: smartobject
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
smartobject-watchify
========================
An extension to make a smartobject instance listenable to its resource changes
[](https://nodei.co/npm/smartobject-watchify/)
[](https://travis-ci.org/lwmqn/smartobject-watchify)
[](https://www.npmjs.com/package/smartobject-watchify)
[](https://www.npmjs.com/package/smartobject-watchify)
[](https://www.npmjs.com/package/smartobject-watchify) [](https://greenkeeper.io/)
[](https://coveralls.io/github/lwmqn/smartobject-watchify?branch=master)
## 1. Overview
This module is used make a smartobject instance able to listen to its resource changes, which could be helpful for creating a machine node responsive to any reosurce change within it.
## 2. Installation
> $ npm install smartobject-watchify --save
## 3. Basic Usage
```js
const SmartObject = require('@lwmqn/smartobject')
const soWatchify = require('@lwmqn/smartobject-watchify')
var so = new SmartObject()
so = soWatchify(so)
so.init('temperature', 0, { sensorValue: 31, units : 'C' })
// attach a listener to receive the change from resource 'temperature/0/sensorValue'
so.onChange('temperature/0/sensorValue', function (cVal, pVal) {
console.log('A listener to this resource')
console.log(cVal) // current value
console.log(pVal) // previous value
})
so.onChange('temperature/0/sensorValue', function (cVal, pVal) {
console.log('Another listener to this resource')
})
// Modify the sensorValue of the temperature sensor and the listener will be triggered
so.write('temperature', 0, 'sensorValue', 80, function (err, data) {
if (err) console.log(err)
})
```
## 4. APIs
*************************************************
### require('smartobject-watchify')(so)
`smartobject-watchify` exports a function that receives the smartobject instance as the parameter to be extended and returned.
**Arguments:**
1. `so` (_Object_): The instance of SmartObject class.
**Returns:**
* (_Object_) Watchified smartobject.
**Examples:**
```js
const SmartObject = require('@lwmqn/smartobject')
const soWatchify = require('@lwmqn/smartobject-watchify')
const so = soWatchify(new SmartObject())
```
*************************************************
### so.onChange(path, listener)
Attach a listener to observe a given resource for its change.
**Arguments:**
1. `path` (_String_): The path to the resource, e.g. `'humidity/6/sensorValue'`.
2. `listener` (_Function_): `function(cVal, pVal) {}`, where `cVal` is the current value and `pVal` is the previous value before updated.
**Returns:**
* (_none_)
**Examples:**
```js
so.onChange('temperature/3/sensorValue', function (cVal, pVal) {
// Listen to 'temperature/3/sensorValue' for its change
})
```
*************************************************
### so.onChangeOnce(path, listener)
Attach an one-time listener to observe a given resource for its change.
**Arguments:**
1. `path` (_String_): The path to the resource, e.g. `'humidity/6/sensorValue'`.
2. `listener` (_Function_): `function(cVal, pVal) {}`, where `cVal` is the current value and `pVal` is the previous value before updated.
**Returns:**
* (_Constructor_) WatchifiedSmartObject
**Examples:**
```js
so.onChangeOnce('presence/7/dInState', function (cVal, pVal) {
// Listen to 'presence/7/dInState' only once for its change
})
```
*************************************************
### so.removeListener(path, listener)
Remove a specified listener from listening to the given resource path.
**Arguments:**
1. `path` (_String_): The path to the resource, e.g. `'humidity/6/sensorValue'`.
2. `listener` (_Function_): The listener function.
**Returns:**
* (_none_)
**Examples:**
```js
var presenceListener = function (cVal, pVal) {
// Listen to 'presence/7/dInState' only once for its change
}
// attach listener
so.onChange('presence/7/dInState', presenceListener)
// remove listener
so.removeListener('presence/7/dInState', presenceListener)
```
*************************************************
### so.removeAllListeners(path)
Remove all listeners from listening to the given resource path.
**Arguments:**
1. `path` (_String_): The path to the resource, e.g. `'humidity/6/sensorValue'`.
**Returns:**
* (_none_)
**Examples:**
```js
so.removeAllListeners('temperature/0/sensorValue')
```
## License
Licensed under [MIT](https://github.com/lwmqn/smartobject-watchify/blob/master/LICENSE).