coap-gateway/

README

coap-gateway

Overview

OCF Servers / Clients communicate over TCP / UDP using the CoAP application protocol. Communication within the OCF Native Cloud shouldn't be restricted to the CoAP protocol, implementation should allow the use of whatever protocol might be introduced in the future. That's why the gateway is the access point for CoAP over TCP, and further communication is OCF Native Cloud specific.

TCP connection to the OCF Native Cloud is by its nature stateful. The OCF CoAP Gateway is therefore also stateful, keeping open connections to the OCF Servers / Clients. The goal of the Gateway is to translate between the OCF Servers / Clients (CoAP) and the protocol of the OCF Native Cloud and communicate in an asynchronous way.

Validation

• OCF CoAP Gateway can accept requests from the OCF Client / Server only after a successful sign-in
• OCF CoAP Gateway can forward requests to the OCF Client / Server only after successful sign-in
• If sign-in was not issued within the configured amount of time or sign-in request failed, OCF Native Cloud will forcibly close the TCP connection
• OCF CoAP Gateway sends command to update device core resource with its status.
  • Online when the device was successfully signed-in and communication lock released
  • Offline when the device was disconnected or signed-out
• Access Token from a successful sign-in must be locally persisted in the OCF CoAP Gateway and linked with an opened TCP channel
• Access Token linked with the opened TCP channel has to be included in each command issued to other OCF Native Cloud components
• OCF CoAP Gateway processes only those commands, which are designated for a device which the Gateway has an opened TCP channel to
• OCF CoAP Gateway is observing each resource published to the resource directory and publishes an event for every change
• OCF CoAP Gateway retrieves each published resource and updates Resources
• OCF CoAP Gateway has to expose the coap ping-pong + retry count configuration, which can be configured during the deployment
• OCF CoAP Gateway has to ping the device in the configured time, if pong is not received after the configured number of retries, then the connection with the device is closed and device is set as offline
• OCF CoAP Gateway processes events from Resources, by issuing a proper CoAP request to the device and raising an event with the response
• OCF CoAP Gateway has to process a waiting request within the configured time, or set the device as offline

Build

Docker

make build-servicecontainer

Local machine

Creates coap-gateway binary.

go build -o coap-gateway ./cmd/service

Configuration

Option	ENV variable	Type	Description	Default
-	ADDRESS	string	tbd	"0.0.0.0:5684"
-	EXTERNAL_PORT	int	tbd	5684
-	NETWORK	string	tbd	"tcp"
-	FQDN	string	tbd	"coap-gw.ocf.cloud"
-	AUTH_SERVER_ADDRESS	string	tbd	"127.0.0.1:9100"
-	RESOURCE_AGGREGATE_ADDRESS	string	tbd	"127.0.0.1:9100"
-	RESOURCE_DIRECTORY_ADDRESS	string	tbd	"127.0.0.1:9100"
-	KEEPALIVE_ENABLE	bool	tbd	true
-	KEEPALIVE_TIMEOUT_CONNECTION	string	tbd	"20s"
-	DISABLE_TCP_SIGNAL_MESSAGE_CSM	bool	tbd	false
-	DISABLE_PEER_TCP_SIGNAL_MESSAGE_CSMS	bool	tbd	true
-	ERROR_IN_RESPONSE	bool	tbd	true
-	GOROUTINE_POOL_SIZE	int	tbd	16
-	NATS_URL	string	tbd	"nats://localhost:4222"
-	MONGODB_URI	string	tbd	"mongodb://localhost:27017"
-	MONGODB_DATABASE	string	tbd	"eventstore"
-	MONGODB_BATCH_SIZE	int	tbd	16
-	MONGODB_MAX_POOL_SIZE	int	tbd	16
-	MONGODB_MAX_CONN_IDLE_TIME	string	tbd	"240s"
-	DIAL_ACME_CA_POOL	string	tbd	""
-	DIAL_ACME_DIRECTORY_URL	string	tbd	""
-	DIAL_ACME_DOMAINS	string	tbd	""
-	DIAL_ACME_REGISTRATION_EMAIL	string	tbd	""
-	DIAL_ACME_TICK_FREQUENCY	string	tbd	""
-	LISTEN_ACME_CA_POOL	string	tbd	""
-	LISTEN_ACME_DIRECTORY_URL	string	tbd	""
-	LISTEN_ACME_DOMAINS	string	tbd	""
-	LISTEN_ACME_REGISTRATION_EMAIL	string	tbd	""
-	LISTEN_ACME_TICK_FREQUENCY	string	tbd	""
-	LISTEN_ACME_DEVICE_ID	string	tbd	""
-	LOG_ENABLE_DEBUG	bool	tbd	false
-	HEARTBEAT	string	tbd	"4s"