Mainflux.mainflux/coap/README.md

Mainflux CoAP Adapter

Mainflux CoAP adapter provides an CoAP 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:

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:

# download the latest version of the service
git clone https://github.com/mainflux/mainflux

cd 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.