BIG-IoT-Gateway

Minimal big-iot gateway using BIG-IOT Golang SDK and Thingful Pipe

How to Build

Please use 'make <target>' where <target> is one of
build-darwin                   Build a darwin x64 executable
build                          Build a linux x64 executable
clean                          Remove all generated artefacts
release                        Create target container with the release version of the app
run                            Run binary on docker container

Usage

BIG-IoT gateway

Usage:
  big-iot-gw start [flags]

Flags:
  -h, --help   help for start

Global Flags:
      --HTTPHost string                HTTP Hostname where will be running the service (default "localhost")
      --HTTPPort int                   HTTP Port where will be running the service
      --aws_key string                 Optional - AWS Access key id
      --aws_region string              Optional - AWS region
      --aws_secret string              Optional - AWS Secret access key
      --config string                  Config file (default is ./config.yaml)
      --offerFile string               Offer file (default is ./offers.json)
      --debug                          enable debug
      --marketPlaceURI string          Main URI for BIG-IoT Market Place (default "https://market.big-iot.org")
      --noauth                         disable auth
      --offerFile string               Config file with offerings (default is ./offerings.yaml)
      --offeringActiveLengthSec int    Offering Active Length Sec (default 300)
      --offeringCheckIntervalSec int   Offering Check Interval in secs (default 600)
      --offeringEndpoint string        Offering End Point
      --pipeAccessToken string         Pipes access token
      --providerID string              Provider ID for BIG-IoT MarketPlace
      --providerSecret string          Provider Secret for BIG-IoT MarketPlace

The app can be configured using these methods ordered by their precedence:

1. Env Vars
2. Flags
3. Configuration file

Example for offeringEndpoint var with a file with the next content:

offeringEndpoint: http://url1

Running: OFFERINGENDPOINT=http://url2 big-iot-gateway start --config config.yaml

Will override the value http://url1 contained in the config file and it will change the value to http://url2

Running: big-iot-gateway start --config config.yaml --offeringEndpoint=http://url3

Will override the value http://url1 contained in the config file and it will change the value to http://url3

Running: big-iot-gateway start --offeringEndpoint=http://url4

Will run without consider the config file at all and must be required to specified all the flags or env vars explicitly.

Offers file

--offerFile flag specify a file with the offers that the gateway need to serve, if the flag and file aren't specified then a default file 'offers.json' will be used, the content of the file are the Big IoT data offers.

The behavior is:

• No offers file -> The gateway will look for a local ./offers.json file

• --offerFile=s3://mybucket/myfile.json -> The gateway will look for aws credentials flags or env vars to connect to AWS S3 mybucket and the offers file file myfile.json

• --offerFile=file://config/offers.json -> The gateway will look for the local file ./config/offers.json

Example Format

{
    "offers": [
      {
        "ID": "offer-id-1",
        "Name": "Name of the offer 1",
        "City": "My City",
        "PipeURL": "https://valid-url-pointing-to-thingful-pipes-data-provider",
        "Category": "bigiot:environmental",
        "Datalicense": "myLicense",
        "Price": 0,
        "Outputs": [
          {
            "BigiotName": "airTemperatureValue",
            "BigiotRDF": "schema:airTemperatureValue",
            "PipeTerm": "temperature"
          }
        ]
      },
      {
        "ID": "offer-id-1",
        "Name": "Name of the offer 2",
        "City": "Barcelona",
        "PipeURL": "https://valid-url-pointing-to-thingful-pipes-data-provider",
        "Category": "bigiot:environmental",
        "Datalicense": "MyLicense",
        "Price": 0,
        "Outputs": [
          {
            "BigiotName": "air_qualityPM10",
            "BigiotRDF": "schema:hasNoiseLevel",
            "PipeTerm": "sound,NoiseLevel"
          }
        ]
      }         
    ]
  }

In order to use S3 based storage for the offers file, the next flags/env vars are needed:

• --aws_key=xxx or AWS_KEY env var
• --aws_secret=xxx or AWS_SECRET env var
• --aws_region=xxx or AWS_REGION

Note: Is possible to use a YAML file for offers configuration but json format is prefered as is less strict.