-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jenkins
committed
Jan 21, 2025
1 parent
c72977c
commit 7b102c5
Showing
21 changed files
with
7,753 additions
and
7,753 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,22 @@ | ||
**Plugins Icon Documentation** | ||
**** | ||
|
||
In order to be published on the Jeedom Market, any plugin must have an icon. | ||
. | ||
|
||
This icon will be the one displayed for users, on the market and from the Jeedom interface. | ||
. | ||
|
||
You must produce a file in png format, 309 x 348 pixels. | ||
. | ||
|
||
The file name is structured like this: `<plugin-id> _icon.png` | ||
: | ||
|
||
It should be saved in the `/plugin-info/` folder | ||
|
||
This file is mandatory. | ||
|
||
We thank you in advance for not using the same color code as the icons of the official Jeedom plugins. | ||
. | ||
|
||
Since 2020, it is recommended to no longer put the name under the image (be careful to keep the same sizes of the model anyway !) | ||
. | ||
|
||
Thank you for using this template (rounded edges, size, colored background, transparency around etc.): | ||
!) | ||
|
||
: | ||
|
||
![modele-icone](images/plugin-Jeedom-px.jpg) | ||
![modele-icon](images/template_icon.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,194 +1,194 @@ | ||
# Order Value | ||
# | ||
|
||
This documentation gathers the recommendations for the values of the commands (action or info) according to the types. It is not mandatory to follow them but for better integration with Jeedom it is strongly recommended to do so. | ||
. . | ||
|
||
## Light | ||
## | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|-------------| | ||
|Info/Light Status|Let Brightness be<br/>0-100 Or 0-99 or 0-255<br/>(depending on the max of Action/Light Slider)<br/>or Either Binary<br/>0 = Off<br/> other than 0 = On<br/>**Mandatory**| | ||
|Info/Light Brightness|Luminosité<br/>0-100 Or 0-99 or 0-255<br/>(depending on the max of Action/Light Slider)<br/>Always use with Light State on binary command| | ||
|Action/Light Slider|Brightness dimmer<br/>Min&Max Mandatory| | ||
|Action/Light On Button|Turning on the light (Changing the state))| | ||
|Action/Light Off Button|Turning off the light (Changing the state))| | ||
|Info/Light Color|#RRGGBB Format| | ||
|Action/Light Color|Color Change, Format #RRGGBB| | ||
|Info/Light Color Temperature|Mired (<=500) or Kelvin (>500) format)| | ||
|Action/Light Color Temperature|Changing the color temperature<br/>Min&Max Mandatory| | ||
|Action/Light Toggle|Invert state if binary| | ||
|Action/Light Mode|Preset/Light scene, can be multiple| | ||
||<br/><br/>()<br/><br/><br/> <br/>****| | ||
||Luminosité<br/><br/>()<br/>| | ||
||<br/>| | ||
||)| | ||
||)| | ||
||| | ||
||| | ||
||)| | ||
||<br/>| | ||
||| | ||
||| | ||
|
||
## Prise | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|----------------|------------| | ||
|Info/Plug<br/>Etat|0 = Off<br/>1 = On| | ||
|Action/Take<br/>On button|Turn on the socket| | ||
|Action/Take<br/>Off button|Turn off the socket| | ||
|<br/>Etat|<br/>| | ||
|<br/>|| | ||
|<br/>|| | ||
|
||
## Interrupteurs | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|----------------|------------| | ||
|Info/Switch<br/>Etat|0 = Off<br/>1 = On| | ||
|Action/Switch<br/>On button|Turn on the switch| | ||
|Action/Switch<br/>Off button|Turn off the switch| | ||
|<br/>Etat|<br/>| | ||
|<br/>|| | ||
|<br/>|| | ||
|
||
## Ventilateur | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|----------------|------------| | ||
|Info/Fan<br/>Etat|0 = Off<br/>1 = On<br/>or gradation if speed| | ||
|Action/Fan<br/>On button|Allumer| | ||
|Action/Fan<br/>Off button|Eteindre| | ||
|Action/Fan<br/>Vitesse<br/>Rotation|Min Max Mandatory| | ||
|<br/>Etat|<br/><br/>| | ||
|<br/>|Allumer| | ||
|<br/>|Eteindre| | ||
|<br/>Vitesse<br/>Rotation|| | ||
|
||
## Volet | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Status Panel|If Binary :<br/>0 = Closed<br/>1 = Open<br/>If Digital :<br/>Slider Button min (otherwise State min, otherwise 0) = Closed <br/>max of Slider Button (otherwise max of State, otherwise 100) = Open<br/>If no Silder button : Min and Max mandatory in the State !| | ||
|Action/Shutter Up Button|Opening the shutter<br/>Start opening or set max slider value or state or 100| | ||
|Action/Shutter Down Button|Closing the shutter<br/>Start closing or set min slider value or state or 0| | ||
|Action/Stop Button Shutter|Stopping the shutter movement| | ||
|Action/Slider Button Pane|Gives the proportion of opening of the shutter<br/>If present:<br/>Min and Max required| | ||
|| :<br/><br/><br/> :<br/> <br/><br/> : !| | ||
||<br/>| | ||
||<br/>| | ||
||| | ||
||<br/>:<br/>| | ||
|
||
optional : | ||
: | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Horizontal Tilt Status Shutter|Angle 0->90° (via slider)| | ||
|Action/Slider Pane Horizontal Tilt|Angle 0->90°<br/>modifiable via min-max of the slider| | ||
|Info/Vertical Tilt Status Shutter|Angle 0->90° (via slider)| | ||
|Action/Slider Shutter Vertical Tilt|Angle 0->90°<br/>modifiable via min-max of the slider| | ||
||)| | ||
||<br/>| | ||
||)| | ||
||<br/>| | ||
|
||
## Valves | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Tap<br/>Etat|0 = Off<br/>1 = On| | ||
|Action/Tap<br/>On button|Allumer| | ||
|Action/Tap<br/>Off button|Eteindre| | ||
|<br/>Etat|<br/>| | ||
|<br/>|Allumer| | ||
|<br/>|Eteindre| | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Irrigation<br/>Etat|0 = Off<br/>1 = On| | ||
|Action/Irrigation<br/>On button|Allumer| | ||
|Action/Irrigation<br/>Off button|Eteindre| | ||
|<br/>Etat|<br/>| | ||
|<br/>|Allumer| | ||
|<br/>|Eteindre| | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Valve<br/>Generic<br/>Etat|0 = Off<br/>1 = On| | ||
|Action/Valve<br/>Generic<br/>On button|Allumer| | ||
|Action/Valve<br/>Generic<br/>Off button|Eteindre| | ||
|<br/><br/>Etat|<br/>| | ||
|<br/><br/>|Allumer| | ||
|<br/><br/>|Eteindre| | ||
|
||
add a dimmer ? and add digital to the action ? it exists ? | ||
? ? ? | ||
|
||
## Serrures | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Lock Status|0 = Not Secure (Not Locked))<br/>1 = Secure (Locked))| | ||
|Action/Lock Open Button|Unlocking| | ||
|Action/Lock Close Button|Verrouillage| | ||
||)<br/>)| | ||
||| | ||
||Verrouillage| | ||
|
||
## Mouvement | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Presence|0 = No movement<br/>1 = Movement| | ||
||<br/>| | ||
|
||
## Opening | ||
## | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Door<br/>Info/Window<br/>(same treatment)|0 = Contact (Closed)<br/>1 = No contact (Open)| | ||
|<br/><br/>()|)<br/>)| | ||
|
||
## Sirens | ||
## | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Siren Status|0 = Does not ring<br/>1 = Ring| | ||
||<br/>| | ||
|
||
## Alarme | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Alarm status|1 = Triggered<br/>(priority on activated and modes)| | ||
|Info/Alarm status activated|0 = Disarmed<br/>(priority over modes)| | ||
|Info/Alarm mode|Label displaying **Exactly** the name of an Action/Alarm Mode command| | ||
|Action/Alarm armed|Arm the alarm| | ||
|Action/Alarm released|Disarm the alarm| | ||
|Action/Alarm Mode|Alarm mode, can be multiple| | ||
||<br/>()| | ||
||<br/>()| | ||
|| **** | | ||
||| | ||
||| | ||
||| | ||
|
||
## Thermostats | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Thermostat Status (BINARY)|0 = Off<br/>1 = On| | ||
|Info/Thermostat Status (HUMAN)|'off' or 'stopped' or 'stop'<br/>'heat' or 'heating''<br/>'cool' or 'air conditioning''<br/><br/>Prefer English| | ||
|Info/Thermostat Mode|'Off' or 'Stop' = OFF<br/>''None' or 'Thermostat' = Setpoint Mode<br/>Label displaying **Exactly** the name of an Action/Thermostat Mode command| | ||
|Action/Thermostat Mode|Thermostat mode, can be multiple| | ||
|Info/Thermostat Outdoor Temperature|Degrees Celsius| | ||
|Info/Thermostat Room temperature|Degrees Celsius| | ||
|Info/Thermostat Setpoint|Value between Min and Max of the Action/Thermostat Setpoint| | ||
|Action/Thermostat Setpoint|Min&Max Mandatory| | ||
|Info/Thermostat Lock|0 = Not Locked<br/>1 = Locked| | ||
|Action/Thermostat Lock|Lock the thermostat| | ||
|Action/Thermostat Unlock|Unlock the thermostat| | ||
|)|<br/>| | ||
|)|''<br/>''<br/>''<br/><br/>| | ||
||'<br/>'<br/> **** | | ||
||| | ||
||| | ||
||| | ||
||| | ||
||| | ||
||<br/>| | ||
||| | ||
||| | ||
|
||
## Gates or Garages | ||
## | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Portal opening status<br/>Info/Garage opening status<br/>(same treatment)|0 = Closed<br/>252 = Closing in progress<br/>253 = Stopped<br/>254 = Opening in progress<br/>255 = Open<br/>(Based on z-wave equipment, could be also binary or labeled ?)| | ||
|<br/><br/>()|<br/><br/><br/><br/><br/>( ?)| | ||
|
||
with either : | ||
: | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Action/Portal or garage toggle button|Switch opens when closed and closes when open<br/>Opening if blocked (for safety))| | ||
||<br/>)| | ||
|
||
or either : | ||
: | ||
|
||
|Generic type | Values / Action | | ||
| | | | ||
|---------------|----------------| | ||
|Action/Gate or garage opening button|Ouverture| | ||
|Action/Gate or garage close button|Fermeture| | ||
||Ouverture| | ||
||Fermeture| | ||
|
||
## Electricité | ||
|
||
|Generic type | Unit | | ||
| | | | ||
|---------------|----------------| | ||
|Info/Electrical Power|Watts| | ||
|Info/Electricity Consumption|KWh| | ||
||Watts| | ||
||KWh| | ||
|
||
## Divers | ||
|
||
|Generic type | Values / Unit | | ||
|---------------|----------------| | ||
|Info/Presence Occupation|0 = Nobody<br/>1 = Someone| | ||
|Info/Air Quality (AQI Index)|AQI index| | ||
|Info/Air Quality (Customizable Index)|ppb or µg/m3| | ||
|Info/CO Detector|0 = normal CO<br/>1 = abnormal CO| | ||
|Info/Brightness|0 → 100000 lux| | ||
|Info/Humidity|%| | ||
|Info/CO2 (ppm)|PPM or binary ?| | ||
|Info/Temperature|-50 → 300 °C| | ||
|Info/Battery|%| | ||
|Info/Battery charging|0 = NO<br/>1 = YES<br/>Not present = Not rechargeable| | ||
|Info/Low Battery|0 = NO<br/>1 = YES| | ||
|Info/Smoke Detection|0 = No smoke<br/>1 = Smoke detected| | ||
|Info/Flood<br/>Info/Water leak|0 = No leak detected<br/>1 = Leak detected| | ||
|Info/Sabotage|0 = No sabotage<br/>1 = Sabotage| | ||
|Info/Shock|0 = No shock<br/>1 = Shock| | ||
|Info/Pressure|bar| | ||
|Info/Sound (dB)|dB| | ||
|
||
## Equipment statuses | ||
|
||
|Generic type | Values / Action | | ||
|---------------|----------------| | ||
|Info/Status Active|0 = inactive<br/>1 = active| | ||
|Info/Online Connectivity|0 = offline<br/>1 = online| | ||
|Info/Status Faulty|0 = no<br/>1 = yes| | ||
| | | | ||
|---------------|----------------| | ||
||<br/>| | ||
|)|| | ||
|)|| | ||
||<br/>| | ||
||| | ||
||| | ||
|)| ?| | ||
||-| | ||
||| | ||
||<br/><br/>| | ||
||<br/>| | ||
||<br/>| | ||
|<br/>|<br/>| | ||
||<br/>| | ||
||<br/>| | ||
||bar| | ||
|)|dB| | ||
|
||
## | ||
|
||
| | | | ||
|---------------|----------------| | ||
||<br/>| | ||
||<br/>| | ||
||<br/>| |
Oops, something went wrong.