mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-11 19:29:16 +08:00
61f1c2e379
* Add open tracing dependencies Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add open tracing to users service Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add open tracing to the things service Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add open tracing to the http adapter Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add open tracing to the ws adapter Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add open tracing to the CoAP adapter Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update LoRa adapter in accordance with changes Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update SDK tests in accordance with changes Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update bootstrap service in accordance with changes Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update reader services with accordance with changes Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update .env and docker-compose file Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add jaeger and timeout env vars Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Fix broken test for can access by id endpoint Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Update deps with proto empty package Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com>
72 lines
3.8 KiB
Markdown
72 lines
3.8 KiB
Markdown
# Mainflux CoAP Adapter
|
|
|
|
Mainflux CoAP adapter provides an [CoAP](http://coap.technology/) API for sending messages through the
|
|
platform.
|
|
|
|
## Configuration
|
|
|
|
The service is configured using the environment variables presented in the
|
|
following table. Note that any unset variables will be replaced with their
|
|
default values.
|
|
|
|
| Variable | Description | Default |
|
|
|--------------------------------|--------------------------------------------------------|-----------------------|
|
|
| MF_COAP_ADAPTER_PORT | Service listening port | 5683 |
|
|
| MF_NATS_URL | NATS instance URL | nats://localhost:4222 |
|
|
| MF_THINGS_URL | Things service URL | localhost:8181 |
|
|
| MF_COAP_ADAPTER_LOG_LEVEL | Service log level | error |
|
|
| MF_COAP_ADAPTER_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
|
|
| MF_COAP_ADAPTER_CA_CERTS | Path to trusted CAs in PEM format | |
|
|
| MF_COAP_ADAPTER_PING_PERIOD | Hours between 1 and 24 to ping client with ACK message | 12 |
|
|
| MF_JAEGER_URL | Jaeger server URL | localhost:6831 |
|
|
| MF_COAP_ADAPTER_THINGS_TIMEOUT | Things gRPC request timeout in seconds | 1 |
|
|
|
|
## Deployment
|
|
|
|
The service is distributed as Docker container. The following snippet provides
|
|
a compose file template that can be used to deploy the service container locally:
|
|
|
|
```yaml
|
|
version: "2"
|
|
services:
|
|
adapter:
|
|
image: mainflux/coap:[version]
|
|
container_name: [instance name]
|
|
ports:
|
|
- [host machine port]:[configured port]
|
|
environment:
|
|
MF_COAP_ADAPTER_PORT: [Service HTTP port]
|
|
MF_NATS_URL: [NATS instance URL]
|
|
MF_THINGS_URL: [Things service URL]
|
|
MF_COAP_ADAPTER_LOG_LEVEL: [Service log level]
|
|
MF_COAP_ADAPTER_CLIENT_TLS: [Flag that indicates if TLS should be turned on]
|
|
MF_COAP_ADAPTER_CA_CERTS: [Path to trusted CAs in PEM format]
|
|
MF_COAP_ADAPTER_PING_PERIOD: [Hours between 1 and 24 to ping client with ACK message]
|
|
MF_JAEGER_URL: [Jaeger server URL]
|
|
MF_COAP_ADAPTER_THINGS_TIMEOUT: [Things gRPC request timeout in seconds]
|
|
```
|
|
|
|
Running this service outside of container requires working instance of the NATS service.
|
|
To start the service outside of the container, execute the following shell script:
|
|
|
|
```bash
|
|
# download the latest version of the service
|
|
go get github.com/mainflux/mainflux
|
|
|
|
cd $GOPATH/src/github.com/mainflux/mainflux
|
|
|
|
# compile the http
|
|
make coap
|
|
|
|
# copy binary to bin
|
|
make install
|
|
|
|
# set the environment variables and run the service
|
|
MF_THINGS_URL=[Things service URL] MF_NATS_URL=[NATS instance URL] MF_COAP_ADAPTER_PORT=[Service HTTP port] MF_COAP_ADAPTER_LOG_LEVEL=[Service log level] MF_COAP_ADAPTER_CLIENT_TLS=[Flag that indicates if TLS should be turned on] MF_COAP_ADAPTER_CA_CERTS=[Path to trusted CAs in PEM format] MF_COAP_ADAPTER_PING_PERIOD: [Hours between 1 and 24 to ping client with ACK message] MF_JAEGER_URL=[Jaeger server URL] MF_COAP_ADAPTER_THINGS_TIMEOUT=[Things gRPC request timeout in seconds] $GOBIN/mainflux-coap
|
|
```
|
|
|
|
## Usage
|
|
|
|
If CoAP adapter is running locally (on default 5683 port), a valid URL would be: `coap://localhost/channels/<channel_id>/messages?authorization=<thing_auth_key>`.
|
|
Since CoAP protocol does not support `Authorization` header (option) and options have limited size, in order to send CoAP messages, valid `authorization` value (a valid Thing key) must be present in `Uri-Query` option.
|