Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coatyio/binding.mqtt.js
Coaty communication binding based on MQTT for JavaScript/TypeScript runnable in Node.js and browsers.
https://github.com/coatyio/binding.mqtt.js
binding coaty communication javascript mqtt typescript
Last synced: about 1 month ago
JSON representation
Coaty communication binding based on MQTT for JavaScript/TypeScript runnable in Node.js and browsers.
- Host: GitHub
- URL: https://github.com/coatyio/binding.mqtt.js
- Owner: coatyio
- License: mit
- Created: 2020-06-03T06:41:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T06:22:57.000Z (about 2 years ago)
- Last Synced: 2024-11-19T14:06:06.962Z (about 2 months ago)
- Topics: binding, coaty, communication, javascript, mqtt, typescript
- Language: TypeScript
- Homepage:
- Size: 841 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Coaty JS - MQTT Communication Binding
[](https://coaty.io)
[](http://www.typescriptlang.org/)
[](https://opensource.org/licenses/MIT)
[](https://conventionalcommits.org/)
[](https://www.npmjs.com/package/@coaty/binding.mqtt)
## Table of Contents
* [Introduction](#introduction)
* [How to use](#how-to-use)
* [Contributing](#contributing)
* [License](#license)
## Introduction
This binding package provides a [Coaty](https://coaty.io) communication binding
for transmitting Coaty communication events via the [MQTT](https://mqtt.org/)
publish-subscribe messaging protocol.
This package comes with complete [API
documentation](https://coatyio.github.io/binding.mqtt.js/api/index.html).
This package is considered the *reference implementation* for all
language-specific Coaty MQTT bindings. It includes the specification of the
[Coaty MQTT communication
protocol](https://coatyio.github.io/binding.mqtt.js/man/communication-protocol/)
which must be implemented by all MQTT bindings in order to be interoperable.
## How to use
You can install the latest version of this binding package in your Coaty
application as follows:
```sh
npm install @coaty/binding.mqtt
```
This npm package targets Coaty projects using ECMAScript version `es5` and
module format `commonjs`. It runs in Node.js and in the browser.
Ensure to always install a binding version that is *compatible* with the
`@coaty/core` framework version you are using in your application, i.e. both
packages must have the same major version.
Next, declare the MQTT binding in your Coaty agent container configuration as
follows:
```ts
import { MqttBinding } from "@coaty/binding.mqtt";
const configuration: Configuration = {
...
communication: {
binding: MqttBinding.withOptions({
brokerUrl: ... ,
...
}),
...
},
...
};
```
Available binding options are described in the [API
documentation](https://coatyio.github.io/binding.mqtt.js/api/interfaces/mqttbindingoptions.html).
## Contributing
If you like this binding, please consider ★ starring [the project on
github](https://github.com/coatyio/binding.mqtt.js). Contributions are welcome
and appreciated.
The recommended practice described in the [contribution
guidelines](https://github.com/coatyio/coaty-js/blob/master/CONTRIBUTING.md) of
the Coaty JS framework also applies here.
To release a new version of this package, follow these steps:
1. `npm run cut-release` - prepare a new release, including automatic
versioning, documentation generation, conventional changelog, and tagging.
2. `npm run push-release` - push the prepared release to the remote git repo
3. `npm run publish-release` - publish the package on npm registry.
## License
Code and documentation copyright 2020 Siemens AG.
Code is licensed under the [MIT License](https://opensource.org/licenses/MIT).
Documentation is licensed under a
[Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).