Components and Services section, you can find information for all possibly available (may differ, depending on the device/device profile) Components
Each Component/Service page in here is structured as follows:
All Components always contain the following methods:
Services may not have
Additionally, component-specific methods are listed on each page.
More information on how to work with those methods can be found in:
- General - RPC Protocol - Protocol used in Shelly Gen2 devices
- General - RPC Channels - Different channels which can be used for working with the API
- General - Component Concept - Core explanation of the concept of a Component
Each Component, would have a configuration, available through
Configuration for Services is optional.
Each Component, would have a status, available through
Status for Services is optional.
Components may trigger web hook events. If such are available, for the specific component, they would be documented in the Webhook Events section.
Notifications are a concept that handles
Each component and service, may support those.
The core ones are:
config_changed - when a configuration (
Component.GetConfig) is changed (mostly via
2) State changes - when a state (in
Component specific articles, where needed
Some components, may introduce their own concepts and require explanation on how they work. For such cases, there would be separate component specific articles.
Examples are a list of requests (with specific methods and parameters), shown together with responses.