Update readme

Author: jason-fox

iot-devices/README.md

@@ -1,84 +1,30 @@
-# FIWARE NGSI-LD Step-by-Step Tutorials Context Provider
+# FIWARE NGSI-LD Step-by-Step Tutorials Dummy Devices
 
-[![Documentation](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/documentation.svg)](https://fiware-tutorials.rtfd.io)
-[![Docker](https://img.shields.io/docker/pulls/fiware/tutorials.ngsi-ld.svg)](https://hub.docker.com/r/fiware/tutorials.ngsi-ld/)
-[![Support badge](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware)
 [![NGSI LD](https://img.shields.io/badge/NGSI-LD-d6604d.svg)](https://cim.etsi.org/NGSI-LD/official/front-page.html)
 [![JSON LD](https://img.shields.io/badge/JSON--LD-1.1-f06f38.svg)](https://w3c.github.io/json-ld-syntax/)
 
-Simple nodejs express application for use with the FIWARE Step-by-Step tutorials. Each tutorial consists of a series of
-exercises to demonstrate the correct use of individual FIWARE components and shows the flow of context data within a
-simple Smart Solution either by connecting to a series of dummy IoT devices or manipulating the context directly or
-programmatically.
+Simple nodejs express application for use with the FIWARE Step-by-Step tutorials.
 
-This application provides various sources of context and demonstrates various aspects of FIWARE To run the application
-in debug mode add `DEBUG=tutorial:*`
+This application provides sends information about devices on the farm.
 
-## Store Application
+### Actuators
 
--   `WEB_APP_PORT=3000` # Port used by the content provider proxy and web-app for viewing
--   `CONTEXT_BROKER=http://orion:1026/v2` - URL of the context broker to update context
--   `NGSI_LD_PREFIX=` - Whether to use full URNs for devices
--   `SECURE_ENDPOINTS=true` - Enable Keyrock as PDP - default is `false`
+- POST `/iot/water:id`  - Actuate the water sprinkler on/off
+- POST `/iot/tractor:id`  - Actuate the tractor start/stop
+- POST `/iot/filling:id` - Actuate the filling level add/remove/fill
 
-## Dummy Ultralight Devices
+### Fire devices
 
--   `IOTA_HTTP_HOST=iot-agent` - The URL of the IoT Agent
--   `IOTA_HTTP_PORT=7896` - Port used by the dummy IoT devices to commuicate with the IoT Agent
--   `DUMMY_DEVICES_PORT=3001` - Port used by the dummy IoT devices to receive commands
--   `DUMMY_DEVICES_TRANSPORT=HTTP` - Default transport used by dummy IoT devices (either `HTTP` or `MQTT`)
--   `DUMMY_DEVICES_API_KEY=4jggokgpepnvsb2uv4s40d59ov` - Device API Key.
+- GET `/status` - send the status of the weather and the barn door
+- GET `/devices/:type` - send the status of devices of a given type
+- GET `/animals` - send the status of the animal collars
 
-## Identity Management - Keyrock
+### Set device states
 
--   `KEYROCK_URL=http://localhost` - URL for Keyrock IDM
--   `KEYROCK_IP_ADDRESS=http://172.18.1.5` - IP address for Keyrock IDM
--   `KEYROCK_PORT=3005` - Port that Keyrock is listening on
--   `KEYROCK_CLIENT_ID=tutorial-dckr-site-0000-xpresswebapp` - Client ID for the appliction within keyrock
--   `KEYROCK_CLIENT_SECRET=tutorial-dckr-site-0000-clientsecret` - Client secret for the appliction within keyrock
+- PUT `/devices/tractor` - - update the status of tractors
+- PUT `/devices` - initialise the cache of all devices
+- PUT `/barndoor` - toggle the barn door open/shut
+- PUT `/weather` - amend the weather - sunny/cloudy/raining
+- PUT `/temperature/:id` - amend the target temperature of a device
 
-## Access Control - Authzforce
-
--   `AUTHZFORCE_URL=http://authzforce` - URL for Authzforce
--   `AUTHZFORCE_PORT=8080` - Port that Authzforce is listening on
-
-## How to build your own image
-
-The [Dockerfile](https://github.com/fiware/tutorials.NGSI-LD/blob/master/docker/Dockerfile) associated with this image
-can be used to build an image in several ways:
-
--   By default, the `Dockerfile` retrieves the **latest** version of the codebase direct from GitHub (the `build-arg` is
-    optional):
-
-```console
-docker build -t fiware/tutorials.NGSI-LD . --build-arg DOWNLOAD=latest
-```
-
--   You can alter this to obtain the last **stable** release run this `Dockerfile` with the build argument
-    `DOWNLOAD=stable`
-
-```console
-docker build -t fiware/tutorials.NGSI-LD . --build-arg DOWNLOAD=stable
-```
-
--   You can also download a specific release by running this `Dockerfile` with the build argument `DOWNLOAD=<version>`
-
-```console
-docker build -t fiware/tutorials.NGSI-LD . --build-arg DOWNLOAD=1.7.0
-```
-
--   To download code from your own fork of the GitHub repository add the `GITHUB_ACCOUNT` and `GITHUB_REPOSITORY`
-    arguments to the `docker build` command.
-
-```console
-docker build -t fiware/tutorials.NGSI-LD . --build-arg GITHUB_ACCOUNT=<your account> --build-arg GITHUB_REPOSITORY=<your repo>
-```
-
-Alternatively, if you want to build directly from your own sources, please copy the existing `Dockerfile` into file the
-root of the repository and amend it to copy over your local source using :
-
-```Dockerfile
-COPY app /usr/src/app
-```
-
-Full instructions can be found within the `Dockerfile` itself.
+To run the application in debug mode add `DEBUG=devices:*`

iot-devices/package.json

@@ -9,6 +9,7 @@
   },
   "scripts": {
     "start": "node ./bin/devices",
+    "local": "DEBUG=devices.* npm start",
     "lint": "eslint . --cache --fix",
     "prettier": "prettier --parser flow --single-quote --write **/**/*.js  **/*.js *.js"
   },