Skip to content

Latest commit

 

History

History
138 lines (102 loc) · 7.7 KB

File metadata and controls

138 lines (102 loc) · 7.7 KB

Thing+ Guide

Read the glossary and follow the flow to develop with Thing+. Even if you do not have equipment yet, we provide a simple virtual gateway and several sensor simulators.

The SandBox may have some incomplete features compared with the commercial site and may be temporarily unavailable.

From time to time, the SandBox will also have new features that are still in testing. Additionally, the SandBox Service may be discontinued without notice, so please keep this in mind when using it.
Please contact us here if you are ready to begin using Thing+ for commercial service - contact@thingplus.net

Contents

1. Glossary

Term Description example
Sensor A hardware used to collect some value or state ex) temperature sensor, humidity sensor, etc
Actuator A hardware designed to receive a command and perform an action ex) camera, switch, etc
Device A group of Sensors. Sometime the group is virtual but most often is real - this can also be referred to as an "Edge Node", "Node","Sensor Node", or "Sensor Device"
Gateways have to include at least one device (in Thing+, not neccessarily physically)
Gateway HW / SW that allows communication with Thing+ servers
Sends sensor values/status to the server or forwards commands from the server to sensors/actuators
Sensor Type Refers to a sensor’s classification regarding the physical quantity that it is capable of taking. On a per-sensor type basis, the unit, icon, etc… is usually different, as well as the rules that can be set using that sensor. ex) temperature, humidity, etc
Tag "Tags" are identifiers used to group and manage sensors/actuators scattered across multiple devices / gateways
OAuth2 A standard Open Protocol that can be used to perform authorization and authentication on Thing+
Service A "Service" is the highest organizational level offered to customers and includes complete administration functions (dashboard locking, sensor selection, etc..). A service can include many "Sites", and in those sites, many gateways, users, sensors, etc..
Site A division inside of a service designed to allow for management of specific groups of users, devices, etc.. - Site's can have their own administrators.
ex) A hospital may be a single "site", or may be divided into multiple sites, each designed to represent a specific physical location, or a specific user group.
Admin An administrator who manages a service or site
User Anyone registered directly to a site are "users"
Rule A feature to automatically execute a function/action according to specific conditions and triggers ex) When the temperature is less than 10 degrees, send a command signal to the boiler actuator

1.1 Additional explanation

  1. Service/Site example

    • Monitor temperature / humidity of each classroom in a school's IoT solution
      • Service - represent the school's entire Thing+ related temperature / humidity management system
      • Site - includes all of the users, devices, and gateways for each classroom
      • Service Admin - Business manager and/or IT manager
      • Site Admin - Manager who manages the hw in each classroom (ex: teacher or caretaker)
      • User - All Students. Can check temperatures for each classroom through PC/Smartphone/etc..
    • IoT solution to measure/analyze electricity usage by apartments
      • Service - Real-time electricity usage across a city's apartments
      • Site - each single apartment complex
      • Service Admin - City-wide apartment director/manager
      • Site Admin - Electrical staff managing the power/usage of electricity of each apartment complex
      • User - Apartment residents. May check their home electricity usage
  2. Example regarding Gateway/Device/Sensor/Tag usage

    • Home IoT with RaspberryPi and an IoT Starter Kit. Assume that there are two temperature and humidity sensors
      • Sensor - temperature sensor, humidity sensor
      • Actuator - Led sensor that can be turned on/off
      • Device - RaspberryPi Starter Kit
      • Gateway - RaspberryPi
      • Tag - temperature sensor 1, humidity sensor 1 both tagged with Room (a geo-local tag basically), temperature sensor 2, humidity sensor2 Tagged Living Room - though this, easily create rules/actions on a per-room basis

2. Workflow

2.1 for hardware interoperation with Thing+(embedded)

2.2 for utilizing OAuth/App

2.3 for interoperation with another Iot platform

  • [To be provided later]

3. Guides

3.1 Sensor Types

Link

3.2 Sensor Type Registration Form

Download

3.3 Registered Gateway Model List

Link

3.4 Gateway Model Registration Form

Download

3.5 Registered Gateway, Device and Sensor List

Link

3.6 Embedded Development Guide

Link

3.7 OAuth Use Guide

Link

3.8 Portal Usage Guide

Link

4. API documentation

Link

4.1 Test Service URL

Our team can set up a test service for you for proof of concept and other small-project work. Please contact the bizteam at contact@daliworks.net if you would like to set up a sandbox test service. This will also allow you to use our API via the sandbox API server below:

https://api.sandbox.thingplus.net/v2

4.2 Commercial Service URL

You will need to have a commercial service with us before using our API. Please connect with our biz team via contact@thingplus.net if you would like to open a commercial account. https://***.thingplus.net/ (*** is your own service)

ex1) https://myiot.thingplus.net/

ex2) https://www.hello.thingplus.net/

NOTE: Please be mindful of what instance your service is on. Currently we support our worldwide instance (.net) and our EU instance (.eu)

Current commercial API server address:

4.3 API Version

The current Thing+ API version and documentation is v2.0.

Changes history

License