Skip to content

Commit

Permalink
[Jenkins] Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Feb 28, 2025
1 parent 17a331e commit 68e8eb3
Show file tree
Hide file tree
Showing 39 changed files with 505 additions and 480 deletions.
2 changes: 1 addition & 1 deletion de_DE/blea/equipement.compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,4 +297,4 @@

Diese Liste basiert auf Benutzer-Feedback. Das Jeedom-Team kann daher nicht garantieren, dass alle Module in dieser Liste zu 100% funktionsfähig sind

2025-02-27 01:21:02
:21:02
2 changes: 1 addition & 1 deletion de_DE/camera/equipement.compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,4 +246,4 @@

Diese Liste basiert auf Benutzer-Feedback. Das Jeedom-Team kann daher nicht garantieren, dass alle Module in dieser Liste zu 100% funktionsfähig sind

2025-02-27 01:20:02
:20:02
2 changes: 1 addition & 1 deletion de_DE/enocean/equipement.compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,4 +277,4 @@

Diese Liste basiert auf Benutzer-Feedback. Das Jeedom-Team kann daher nicht garantieren, dass alle Module in dieser Liste zu 100% funktionsfähig sind

2025-02-27 01:17:02
:17:02
5 changes: 5 additions & 0 deletions de_DE/plugins/wellness/airzone/beta/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
>Zur Erinnerung: Wenn keine Informationen über die Aktualisierung vorliegen, liegt dies daran, dass es sich nur um die Aktualisierung von Dokumentation, Übersetzung oder Text handelt.

##

-


## 23/01/2025

- Ajout Option à cocher si l'equipement est un WebServer
Expand Down
2 changes: 1 addition & 1 deletion en_US/blea/equipement.compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,4 +297,4 @@

This list is based on user feedback, the Jeedom team cannot therefore guarantee that all the modules in this list are 100% functional

2025-02-27 01:21:02
:21:02
2 changes: 1 addition & 1 deletion en_US/camera/equipement.compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,4 +246,4 @@

This list is based on user feedback, the Jeedom team cannot therefore guarantee that all the modules in this list are 100% functional

2025-02-27 01:20:02
:20:02
44 changes: 22 additions & 22 deletions en_US/dev/cmd_value.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# 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
##

| | |
|---------------|-------------|
|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/><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/>|
||<br/><br/>()<br/><br/><br/> <br/>****|
||Luminosité<br/><br/>()<br/>|
||<br/>|
||)|
||)|
Expand Down Expand Up @@ -47,13 +47,13 @@ This documentation gathers the recommendations for the values of the commands (a

| | |
|---------------|----------------|
|| :<br/><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 !|
|| :<br/><br/><br/> :<br/> <br/><br/> : !|
||<br/>|
||<br/>|
|||
||<br/>If present:<br/>|
||<br/>:<br/>|

optional :
:

| | |
|---------------|----------------|
Expand All @@ -78,11 +78,11 @@ optional :

| | |
|---------------|----------------|
|<br/>Generic<br/>Etat|<br/>|
|<br/>Generic<br/>|Allumer|
|<br/>Generic<br/>|Eteindre|
|<br/><br/>Etat|<br/>|
|<br/><br/>|Allumer|
|<br/><br/>|Eteindre|

add a dimmer ? and add digital to the action ? it exists ?
? ? ?

## Serrures

Expand All @@ -102,9 +102,9 @@ add a dimmer ? and add digital to the action ? it exists ?

| | |
|---------------|----------------|
|<br/>Info/Window<br/>()|)<br/>)|
|<br/><br/>()|)<br/>)|

## Sirens
##

| | |
|---------------|----------------|
Expand All @@ -116,7 +116,7 @@ add a dimmer ? and add digital to the action ? it exists ?
|---------------|----------------|
||<br/>()|
||<br/>()|
|| **Exactly** |
|| **** |
|||
|||
|||
Expand All @@ -126,8 +126,8 @@ add a dimmer ? and add digital to the action ? it exists ?
| | |
|---------------|----------------|
|)|<br/>|
|)|''<br/>'heat' or 'heating''<br/>'cool' or 'air conditioning''<br/><br/>|
||'<br/>''None' or 'Thermostat' = Setpoint Mode<br/> **Exactly** |
|)|''<br/>''<br/>''<br/><br/>|
||'<br/>'<br/> **** |
|||
|||
|||
Expand All @@ -137,19 +137,19 @@ add a dimmer ? and add digital to the action ? it exists ?
|||
|||

## Gates or Garages
##

| | |
|---------------|----------------|
|<br/>Info/Garage opening status<br/>()|<br/>252 = Closing in progress<br/>253 = Stopped<br/>254 = Opening in progress<br/>255 = Open<br/>( ?)|
|<br/><br/>()|<br/><br/><br/><br/><br/>( ?)|

with either :
:

| | |
|---------------|----------------|
||<br/>)|

or either :
:

| | |
|---------------|----------------|
Expand Down Expand Up @@ -185,7 +185,7 @@ or either :
||bar|
|)|dB|

## Equipment statuses
##

| | |
|---------------|----------------|
Expand Down
66 changes: 33 additions & 33 deletions en_US/dev/core4.0.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,74 @@
## Core v4.0 | Plugin Developers
## .0 |

### Deprecated

- Font-awesome 4 is no longer integrated into Core, replaced by Font-Awesome 5 [migration](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#name-changes).
- [](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#name-changes).

### V4 compatibility on the market
###

The v3 which will be released in November 2020 will have a migration module allowing you to move from V3 to V4.
.

During the migration phase from v3 to v4, plugins without v4 compatibility in their info.json will alert the end user before the update.
..


If your plugin is v4 compatible, indicate it in the info.json of your plugin.
..

Example **info.json**: `"compatibility" : ["miniplus","smart","rpi","docker","diy","v4"],`
****: `"compatibility" :

You can test from a scenario / Code block if your plugins have the correct compatibility entered:
:

<details>

<summary markdown="span">scénario / bloc Code</summary>

~~~ php

{% raw %}
//Author of plugins to check (case sensitive)
)
$author = 'Jeedom SAS';

$plugins = repo_market::byFilter(['author' => $author]);
$pluginsArray = utils::o2a($plugins);
$countPlugins = 0;
$countIncompatibles = 0;
foreach ($pluginsArray as $plugin) {
if ($plugin['author'] == $author) {
) {
) {
$countPlugins++;
if ($plugin['hardwareCompatibility']['v4'] != '1') {
'] != '1') {
$countIncompatibles++;
$scenario->setLog('Plugin ' . $plugin['name'] . ' does not have v4 compatibility tag.');
}
}
}
if ($countPlugins > 0) {
if ($countIncompatibles > 0) {
) {
) {
$scenario->setLog($author . ' : ' . $countIncompatibles . ' potentially incompatible Jeedom V4 plugin on ' . $countPlugins . ' checked');
} else {
} {
$scenario->setLog('All ' . $countPlugins . ' plugin developed by ' . $author . ' are Jeedom V4 compatible. Congratulations!');
}
} else {
} {
$scenario->setLog('No plugin found for ' . $author);
}
{% endraw %}
~~~


</details>

### Adapting plugins for Core v4

- Clean up inline styles as much as possible (see [plugin template](https://github.com/jeedom/plugin-template/blob/master/desktop/php/template.php)).
- span command display : class `state`
- Control button : a class `action`
- On input groups:
- class `roundedLeft` on the first element (a input, button etc)
- class `roundedRight` on the last element (a input, button etc)
- On the eqLogicThumbnailContainer div:
- Delete all styles!
- On parent divs, add a color class:
- logo colors: `logoPrimary` and `logoSecondary`
- Green : `success`
###

- [](https://github.com/jeedom/plugin-template/blob/master/desktop/php/template.php)).
- :
- :
- :
- )
- )
- :
- !
- :
- :
- : `success`
- bleu: `info`
- orange: `warning`
- red : `danger`
- : `danger`
- : ) :
- :
- :
Expand Down Expand Up @@ -111,7 +111,7 @@ You can test from a scenario / Code block if your plugins have the correct compa
- .

.).
[plugin template](https://github.com/jeedom/plugin-template/blob/master/plugin_info/pre_install.php)
[](https://github.com/jeedom/plugin-template/blob/master/plugin_info/pre_install.php)

###

Expand Down
2 changes: 1 addition & 1 deletion en_US/dev/core4.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Core v4.1 | Plugin Developers
## .1 |

### Obsolete

Expand Down
Loading

0 comments on commit 68e8eb3

Please sign in to comment.