# @senseering/worker > Client library to connect to the [manager](https://github.com/Senseering/manager). Latest version **1.6.3** (published 2021-01-29) · ISC license · 0 weekly downloads ## Install ```sh npm install @senseering/worker pnpm add @senseering/worker yarn add @senseering/worker bun add @senseering/worker ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.6.3 | | Published | 2021-01-29 | | First published | 2020-05-20 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 11 | | Unpacked size | 344.3 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Maintainers | se-team | ## Links - npm: https://www.npmjs.com/package/@senseering/worker - Repository: https://github.com/Senseering/worker_js - Homepage: https://github.com/Senseering/worker_js#readme - Issues: https://github.com/Senseering/worker_js/issues - npm.io page: https://npm.io/package/@senseering/worker ## Dependencies (11) - [ws](https://npm.io/package/ws.md) ^7.3.1 - [ajv](https://npm.io/package/ajv.md) ^6.12.5 - [uuid](https://npm.io/package/uuid.md) ^8.3.0 - [debug](https://npm.io/package/debug.md) ^4.2.0 - [colors](https://npm.io/package/colors.md) ^1.4.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.20 - [node-rsa](https://npm.io/package/node-rsa.md) ^1.1.1 - [minimatch](https://npm.io/package/minimatch.md) ^3.0.4 - [bufferutil](https://npm.io/package/bufferutil.md) ^4.0.1 - [utf-8-validate](https://npm.io/package/utf-8-validate.md) ^5.0.2 - [fast-json-stable-stringify](https://npm.io/package/fast-json-stable-stringify.md) ^2.1.0 ## Recent versions - 1.6.3 (latest) — 2021-01-29 - 1.6.2 — 2020-12-16 - 1.6.1 — 2020-12-15 - 1.6.0 — 2020-12-11 - 1.5.1 — 2020-10-14 - 1.5.0 — 2020-10-13 - 1.4.2 — 2020-10-02 - 1.4.1 — 2020-08-24 - 1.4.0 — 2020-08-24 - 1.3.15 — 2020-08-14 - 1.3.14 — 2020-08-14 - 1.3.13 — 2020-08-14 - 1.3.12 — 2020-08-14 - 1.3.11 — 2020-08-14 - 1.3.10 — 2020-08-14 - … 7 more at https://npm.io/package/@senseering/worker/versions ## README

A Node.js based, device and service connector.

Apache 2.0 license Discord

## Motivation Connecting IoT devices and services to management tools and anlytics can be cumbersome. The Senseering Worker provides a simple interface to the senseering world written in Node.js. Examples for common scenarios (e.g. MQTT, HTTP and OPC-UA) can be found in the given example repository. ## Installation This is a [Node.js](https://nodejs.org/en/) module available through the [npm registry](https://www.npmjs.com/). Before installing, [download and install Node.js](https://nodejs.org/en/download/). Installation is done using the [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally): ```sh npm install @senseering/worker ``` ## Worker Description A worker is the basic building block for our approach to a decentralised data plattform. It utilizes the manager for storing, managing and selling our data on the senseering myDataEconomy-plattform. The workers objective is to process or generate data based on sensor inputs or other available feeds. It can be run as a source that only publishes data to your liking (e.g. send every few seconds the new sensor inputs) or as a service, which provides a service function that can be triggered on demand (e.g. a weather station that should only publish on demand or an image recognition service). Also a mixture of those two types is possible. This should give a short introduction to workers and the possible use cases. Below you can find more information to the config object and the api of `worker_js`. ### Config object high level description | Property | Subproperty | | Type | Description | |--------|--------|----------|------|------| | credentials | | | String | Identifier for connection to manager in format ':' | | url | | | String | Protocol and domain of manager | | settings | | | Object | Some general settings on the worker's behaviour | | | qualityOfService | | Number | 0: receive at most once, 1: receive at least once | | | messageRetries | | Number | Number of tries for sending of messages | | | messageTimeout | | Number | Number of milliseconds to wait until timeout of message | | meta | | | Object | with key-value-pairs, meta field can be added to the data packages of this worker | | payment | | | Object | Fixed price and boolean option for additional pricing | | | fixCost | | Integer | Fixed costs of the data packages | | | isFixCostOnly | | Boolean | Can additional costs apply? | | profile | | | Object | General information on worker | | | name | | String | The fully qualified name by which the worker should be called | | | location | | Object | 2D GPS coordinate of the worker | | | | latitude | Number | Latitude of worker location | | | | longitude | Number | Longitude of worker location | | privKey | | String | URI reference to the private key used to signing | | schema | | Object | Either single or community schema and boolean option for schema check on worker | | | input | String | URI reference to the input schema in .json format | | | output | String | URI reference to the output schema in .json format | | info | | | Object | object containing all relevant information | | | worker | | Object | information for worker | | | | description | String | URI reference to the worker info in .md format | | | | tags | Array | tags under which this worker wants to be found | | | input | | Object | information for input data | | | | description | String | URI reference to the input info in .md format | | | | tags | Array | tags under which this worker wants to be found | | | output | | Object | information for output data | | | | description | String | URI reference to the output info in .md format | | | | tags | Array | tags under which this worker wants to be found | ### Worker API #### worker.connect: ##### config (object): The config object of the worker Sets up the connection to the manager, registers the worker and generates keys. #### worker.publish: ##### data (object): Object that will be published Publishes desired data on the manager #### worker.provide: ##### service (function): function that returns data Provides the service function that can be triggered on demand #### worker.settings.get: ##### No parameters Returns the current settings of the connection to the manager #### worker.settings.update: ##### settings (object): New settings object for worker Updates the settings of the connection of the worker to the manager (First use worker.settings.get and modify the resulting object, before handing it to worker.settings.update) #### worker.meta.get: ##### No parameters Returns the currently used meta data that are added to each published data point #### worker.meta.update: ##### meta (object): New meta data object that will be added to each data point before publication Updates the meta data #### worker.disconnect: ##### No parameters Stops the connection to the manager ### Templates in workers A detailed explanation to templates and the idea behind it can be found in the `template_js` repository. For the worker itself it is only needed to know that templates are a high level description of the exact data structure in JSON-LD Format. The incoming and outgoing data must be described in that way so every worker knows what to expect from the incoming data and is able to work on it. --- _Source: https://npm.io/package/@senseering/worker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._