Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The diagram below describes the resources that can be managed using the Smartenit API.



 

 

 

  • Companies: Companies are entities (containers) set up to manage the entire ecosystem in an isolated instance. For example, all Smartenit account and users fall under the Smartenit company resource.
  • Accounts: Groups resources under an account owner.  The account owner can share resources securely with family and friends or support staff.
    • Users: User objects hold information of a Smartenit User.
  • Apps: Applications are the middleman between the API and the clients, like mobile phones or web apps. Applications are created by third-party developers to enhance your experience with IoT devices.
  • Areas: Areas group devices and other areas together, examples for areas are: Home, Office, Home first floor or Main room.
  • Devices: Devices are physical or virtual objects that you can use or control, remotely or automatically, in your Smart Location like home or office.
    • Component: Is a device physical unit, for example, a single device can have 2 switches, this will result in 2 components one per switch.
    • Processor: Is a logical unit inside components that can describe the functionalities of the component, for example, a device component can have 2 processors one for switch control and another one for electrical metering monitoring. Processors describe a component functionality composed by methods and attributes.
    • Method: A command that can be executed, such as On or Off
    • Attribute: A processor value that can be read or written. such as OnOff status, or dimmer-level-status.
  • Notifications: A Notification is messages that can be delivered by several means like Push notifications, email, SMS or call. Notifications can have several types and content, like intrusion alerts or support information.
  • Pairing: Pairings allows the user to "pair" (sometimes also referred as linking, binding) one device to another device.
  • Permissions: Permissions let you specify who has access to Smartenit resources, and what actions they can perform on those resources.
  • Scenes: Scenes are a collection of pre-configured states of a collection of devices, Scenes allow to configure several devices to a particular state and activate all those states at once.
    • Controllers: Devices that trigger (button) the scene to be activated.
    • Responders: Devices are move to a pre-defined state definition upon receiving the Scene activate command.
  • Actions: Also termed as Automation Rules to users. It is a collection of conditions and effects that allow user to schedule and automate operation on devices. For example: Make coffee every weekday at 8am. It is labelled as Automation Rules to users
    • Conditions: They are part of Actions and specify what is to be evaluated. Can be time based or device based and are used to create a schedule or rule.
    • Effects: They are also part of Actions and specify what to do when Conditions are met. 
  • Metrics: Contains information about a metric from a given resource, for instance, a device (resource) and its current energy consumption (metric)
  • Locations: Simulates a physical location to group other resources such as devices and areas. Also used for deriving sunset, sunrise and time offset. For example, A user can create Home and Office as locations to group all the devices, areas, and other resources.
  • Events: They are time elements that occur in the API. For example, Device turned on is registered as an event.
  • MicroApps: Used to create another type of grouping for users.  This provides more customization for users to control devices based on a specific solution. For example, a user can create a Security MicroApp and arrange the Camera, sensors and security panel, all in single view to quickly monitor and control the Security aspect of their home.


 

Next Steps

Check the Authentication and Authorization section to learn how to gain access to resources.