Skip to content

Commit

Permalink
test template
Browse files Browse the repository at this point in the history
  • Loading branch information
kcech committed Jan 3, 2019
1 parent 6ba4e37 commit 8bb8819
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions docs/api_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,16 @@ Contents:
api_docs/general_model
api_docs/security
api_docs/services

The Application Programming Interface (API) define a set of commands,
functions and protocols that must be followed by who wants to interact
with the platform from external systems, like sensors/actuators or
applications.

The starting capacities of the platform related to its external
interface are:
The Application Programming Interface (API) of Sentilo defines a set of commands,
functions and protocols that must be followed by who wants to interact with the system externally.

- Allow registering applications/modules and providers/sensors in the
platform (Catalog).
- Allow to applications/modules and sensors to subscribe to services
defined in the catalog as well as post events(Publish/Subscribe).
- Allow sending information from sensors to applications/modules
(Data).
- Allow sending orders from applications/modules to sensors (Order).
This area defines the Application Programming Interface (API), that any sensor or application must use to interact
with the platform.

The starting capacities of the platform related to its external interface are:

- Allows to register applications/modules and providers/sensors in the platform (Catalog).
- Allow to applications/modules and sensors subscribe to services defined in the catalog as well as post events occurring (Publish/Subscribe).
- Allow you to send information from sensors to applications/modules (Data).
- Allows to send orders from applications/modules to sensors (Order).

0 comments on commit 8bb8819

Please sign in to comment.