Skip to content

Latest commit

 

History

History
268 lines (241 loc) · 7.66 KB

cheatsheet.md

File metadata and controls

268 lines (241 loc) · 7.66 KB
Raw

Table of Contents

REST Targets

/check

  • GET - Fetches the health of the rest server. It returns a JSON object with one key status, which can be ok or degraded. An ok indicates that both the mongodb and redis connections are in the connected state connected.

/user

  • GET - Fetch user profile info
  • PUT - Update user info
  • /token
    • GET - Simply get's the user's real id
    • POST - Generate a user token
    • DELETE - Delete the user's token
  • /mydevices
    • GET
  • /mylocations
    • GET
  • /shortcuts
    • GET - Get all user shortcuts
    • POST - Create a user shortcut
  • /shortcuts/<shct_id>
    • DELETE - Delete the user shortcut
  • /group/<grp_id>
    • DELETE - Leave group
  • /all
    • GET - Get's all the user's information

/group

  • GET- Fetch all group info

  • /<group_id>

    • GET - Fetch info for a group
    • DELETE - Delete a group
    • /members
      • GET - Get memebrs for a group
    • /notmembers
      • GET - Get member not in group
    • /member
      • PUT - Remove a member from a group
      • POST - Add a member to a group

/location

  • GET - Get root location
  • POST - Create new location at root

  • /<loc_id>

    • GET - Fetch location info
    • POST - Create new child location
    • PUT - Update a location
    • DELETE - Delete location
    • /devices
      • GET - Fetch immediate devices
    • /alldevices
      • GET - Fetch recursive all devices

/device

  • GET - Get all devices' info (You can actually ask for all devices) You can optionally do an exact name search by adding ?name=NAME_OF_DEVICE to the request.
  • POST - Create new device

  • /<dev_id>

    • GET - Get the device's info
    • PUT - Update the device
    • DELETE - Delete the device

    • /transducer

      • GET - Fetch all transducers' info
      • POST - Create a new transducer
        Example Request 
          {
      "name":"Temperature",
      "unit":"Celsius",
      "is_actuable": false
  }

    • /transducer/<trans_id>, where <trans_id> can be the actual transducer ID or the transducer's name.

      • GET - Get time-series data for the given transducer
      • POST - Publish data to the transducer. Can take Content-Type: plain/text.
      • DELETE - Delete the transducer

    • /token

      • PUT
      • DELETE

    • /command

      • GET - Get list of commands

    • /command/<cmd_id>

      • GET

    • /command/<cmd_id>/publiclink

      • GET
      • POST

    • /service/<srv_id>

      • POST
      • PUT
      • DELETE

    • /acl/users

      • GET

    • /acl/groups

      • GET

    • /acl/<user_or_group_id>

      • POST - Grant access to user or group
      • PUT - Update access to user or group
      • DELETE - Remove access to user or group

  • /search/transducer?q=<query>

    • GET - Search by transducer name. (Optional: search by comma separated list of names)

/devicegroup

  • TODO

/devicetemplate

  • TODO

/service

  • GET - Get all services
    Example Response 
      [
      {
          "_id": "592880c57d6ec25f901d9668",
          "updated_at": "2018-03-04T03:17:40.541Z",
          "created_at": "2017-05-26T19:23:49.953Z",
          "owner": {
              "_id": "5911f5ab65dd1376d1996d3f",
              "email": "hesling.craig@gmail.com",
              "name": "Craig Hesling",
              "id": "5911f5ab65dd1376d1996d3f"
          },
          "name": "LoRaWAN",
          "description": "LoRaWAN device registration",
          "__v": 22,
          "properties": {
              "AppServerTarget": "something",
              "AppServerApplicationID": "somenumber"
          },
          "config_required": [
              {
                  "key_name": "DevEUI",
                  "key_description": "A device's unique identifier (8 byte hexadecimal)",
                  "key_example": "1122334455667788",
                  "key_required": true
              },
          ],
          "status": {
              "timestamp": "2018-03-04T03:17:40.541Z",
              "message": "Running"
          },
          "pubsub": {
              "protocol": "MQTT",
              "endpoint": "openchirp/services/592880c57d6ec25f901d9668",
              "events_endpoint": "openchirp/services/592880c57d6ec25f901d9668/thing/events",
              "status_endpoint": "openchirp/services/592880c57d6ec25f901d9668/status"
          },
          "device_permission": 0,
          "id": "592880c57d6ec25f901d9668"
      }
  ]
  • POST - Create a new service

  • /<srv_id>

    • PUT - Update service settings
    • DELETE - Delete a service
    • /things
      • GET - Get all linked devices list/info
    • /token
      • POST - Generate the service token
      • PUT - Regenerate the service token
      • DELETE - Delete the service token

/admin

  • TODO

MQTT Topics

openchirp/device/<dev_id>

  • /<any_topic> - Timeseries recorded transducer topics
  • /<any_topic_prefix>/<any_2nd_level_topic> - Topics for device related communication that should not be recorded by time series.

openchirp/service/<srv_id>

  • /thing/events
    Example Device Event - New 
          {
          "action":"new",
          "thing":{
              "type":"device",
              "id":"5aa7198f69da9508643081c1",
              "pubsub":{
                  "protocol":"MQTT","endpoint":"openchirp/device/5aa7198f69da9508643081c1"
              },
              "config":[
                  {"key":"rxconfig","value":"blahRX"},
                  {"key":"txconfig","value":"blahTX"}
              ]
          }
      }
    Example Device Event - Update 
          {
          "action":"update",
          "thing":{
              "type":"device",
              "id":"5aa7198f69da9508643081c1",
              "pubsub":{
                  "protocol":"MQTT","endpoint":"openchirp/device/5aa7198f69da9508643081c1"
              },
              "config":[
                  {"key":"rxconfig","value":"blahNewRX"},
                  {"key":"txconfig","value":"blahTX"}
              ]
          }
      }
    Example Device Event - Delete 
          {
          "action":"delete",
          "thing":{
              "type":"device",
              "id":"5aa7198f69da9508643081c1",
              "pubsub":{
                  "protocol":"MQTT",
                  "endpoint":"openchirp/device/5aa7198f69da9508643081c1"
              }
          }
      }
  • /status - Dual use, push device-service link status and service's main status.

Developer Notes

  • Service configs are totally free form. You can link to a service without conforming to it's specified required config scheme. The config could be one number, a string, an array, or maybe even a json object.