Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reelyactive/barnacles-tds
Write ambient IoT sensor data from Pareto Anywhere open source middleware to SQL Server using TDS. We believe in an open Internet of Things.
https://github.com/reelyactive/barnacles-tds
dynamb iot pareto-anywhere raddec sql-server tds
Last synced: 3 months ago
JSON representation
Write ambient IoT sensor data from Pareto Anywhere open source middleware to SQL Server using TDS. We believe in an open Internet of Things.
- Host: GitHub
- URL: https://github.com/reelyactive/barnacles-tds
- Owner: reelyactive
- License: mit
- Created: 2024-09-10T19:04:41.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-23T19:26:18.000Z (3 months ago)
- Last Synced: 2024-09-29T14:02:32.439Z (3 months ago)
- Topics: dynamb, iot, pareto-anywhere, raddec, sql-server, tds
- Language: JavaScript
- Homepage: https://www.reelyactive.com/pareto/anywhere/
- Size: 111 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# barnacles-tds
**barnacles-tds** writes IoT data to a SQL Server database using TDS (Tabular Data Stream).
**barnacles-tds** ingests a real-time stream of _raddec_ and _dynamb_ objects from [barnacles](https://github.com/reelyactive/barnacles/) which it writes to the specified SQL Server database as JSON. It couples seamlessly with reelyActive's [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source IoT middleware.
**barnacles-tds** is a lightweight [Node.js package](https://www.npmjs.com/package/barnacles-tds) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.
## Pareto Anywhere integration
A common application of **barnacles-tds** is to write IoT data from [pareto-anywhere](https://github.com/reelyactive/pareto-anywhere) to a SQL Server database. Simply follow our [Create a Pareto Anywhere startup script](https://reelyactive.github.io/diy/pareto-anywhere-startup-script/) tutorial using the script below:
```javascript
#!/usr/bin/env node
const ParetoAnywhere = require('../lib/paretoanywhere.js');
let pa = new ParetoAnywhere();
// Edit the options to match your SQL Server configuration
const BARNACLES_TDS_OPTIONS = {
config: {
server: '127.0.0.1',
authentication: {
type: 'default',
options: {
userName: 'admin',
password: 'admin',
},
},
options: {
database: 'reelyactive',
},
},
raddecTable: 'raddec',
raddecColumn: 'raddec',
dynambTable: 'dynamb',
dynambColumn: 'dynamb',
handleEventCallback: () => {},
};
// ----- Exit gracefully if the optional dependency is not found -----
let BarnaclesTDS;
try {
BarnaclesTDS = require('barnacles-tds');
} catch (err) {
console.log('This script requires barnacles-tds. Install with:');
console.log('\r\n "npm install barnacles-tds"\r\n');
return console.log('and then run this script again.');
}
// -------------------------------------------------------------------
pa.barnacles.addInterface(BarnaclesTDS, BARNACLES_TDS_OPTIONS);
```
## MS SQL Server Setup
Use the following query to setup the table that will store the dynamb messages.
The column name can be changed if desired, and is configurable through the options.
```
CREATE TABLE dynamb (
_storeId int NOT NULL IDENTITY PRIMARY KEY,
dynamb VARCHAR(8000) NOT NULL,
)
```
## Options
**barnacles-tds** supports the following options:
| Property | Default | Description |
| :----------- | :------------------ | :--------------------------------------------------------------------------------------- |
| config | { /_ See below _/ } | See [Tedious Connection config](https://tediousjs.github.io/tedious/api-connection.html) |
| raddecTable | "raddec" | Name of table in which to store raddecs |
| raddecColumn | "raddec" | Name of column in which to store raddec |
| dynambTable | "dynamb" | Name of table in which to store dynambs |
| dynambColumn | "dynamb" | Name of column in which to store dynamb |
The default config is as follows:
{
server: "127.0.0.1",
authentication: {
type: "default",
options: { userName: "admin", password: "admin" }
},
options: {
encrypt: false,
database: "pareto-anywhere"
}
}
## Contributing
Discover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).
## Security
Consult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.
## License
MIT License
Copyright (c) 2024 [reelyActive](https://www.reelyactive.com)
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.