# Fundamentum SDK MQTT

[![Crates.io][crate-badge]][crate-url]
[![License][licence-badge]][licence-url]
[![Build Status][build-badge]][build-url]
[![Docs.rs][doc-badge]][doc-url]

[Website][website-url] | [Docs][doc-url]

> :warning: **Warning**  
> We do not offer any support or guarantee of backward compatibility for this library.  
> We strongly recommend using the [Fundamentum Edge Daemon][repo-edge-daemon] along with its
> associated [Proto files][repo-edge-proto] for a stable and supported experience.

Rust MQTT client targeting Fundamentum IoT's MQTT broker.

The Fundamentum's MQTT SDK is designed to quickly set up a Rust environment
with an MQTT client, focusing on consuming Fundamentum's MQTT services.

### Example

To test your environment, you can build and run a simple command-line
application. Check out the [examples](./examples/) directory for code
samples.

```bash
$ cargo run --example pubsub -- \
  --private-key ./rsa_private.pem \
  --project-id 13 --region-id 1 --registry-id 12 \
  --serial 123456789
# ..
```

#### Examples

 -  `pubsub`: an advanced example with heartbeat and pub/sub pattern.
 -  `commands`: a basic example with the commands workflow.
 -  `heartbeat`: a very simple example with the heartbeat.
 -  `config`: a very simple example that prints the current configuration.

## Maintainer

See separate [maintainer](./doc/maintainer.md) page.

## License

Licensed under Apache License, Version 2.0 [LICENSE](./LICENSE).

[crate-badge]: https://img.shields.io/crates/v/fundamentum-sdk-mqtt.svg
[crate-url]: https://crates.io/crates/fundamentum-sdk-mqtt
[licence-badge]: https://img.shields.io/badge/license-apache_2.0-blue.svg
[licence-url]: https://bitbucket.org/amotus/fundamentum-sdk-mqtt/src/master/LICENSE
[build-badge]: https://img.shields.io/bitbucket/pipelines/amotus/fundamentum-sdk-mqtt/master
[build-url]: https://bitbucket.org/amotus/fundamentum-sdk-mqtt/pipelines
[doc-badge]: https://docs.rs/fundamentum-sdk-mqtt/badge.svg
[doc-url]: https://docs.rs/fundamentum-sdk-mqtt
[website-url]: https://www.dimonoff.com/services/fundamentum-iot-platform-paas

[repo-edge-daemon]: https://bitbucket.org/amotus/fundamentum-edge-daemon
[repo-edge-proto]: https://bitbucket.org/amotus/fundamentum-edge-proto