| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Présentation
Cette page vous décrit comment définir dans le format JSON les liens externes qui permettront d'accéder à la météo de l’extérieur.
Vous allez pouvoir Elle permet de définir :
- Le comportement par défaut des liens de votre la météo.,
- Les paramètres de chaque lien, si vous souhaitez avoir un comportement spécifique par lien.
| Info |
|---|
Pour les liens externes, on ne parle pas de "zone d'entête" mais de "barre d'information". Ces deux éléments présentent les mêmes informations, mais la différence réside dans le fait que la "barre d'information" dans les liens externes peut être personnalisée et déplacée ( voire supprimée ). Ce qui implique donc que la "barre d'information" peut ne pas se trouver en haut de la page, d'où la différence de noms. |
Description
| Info |
|---|
Les URL des liens sont construites de la façon suivante : <link_base_url>/service-weather/<link_external_part_url>/<weather_uuid>/<link_uuid> |
Ajout d'un nouveau lien externe
Dans le format, JSON, le rajout d'un nouveau lien se fait au niveau de la partie "links" .
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
"external_links" : {
...
"links": [
{
DEFINITION DU LIEN 1
},
{
DEFINITION DU LIEN 2
},
...
]
...
}
... |
Définition d'un lien externe
Paramètres des liens externes
Les liens vont être définis à l'aide de paramètres composés ( "clé" : "valeur" )
- du nom,
- de la valeur.
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
{
"link_name": "external portal display",
"authentication_needed": true,
},
... |
Un paramètre peut être non défini, mais avoir une valeur :
- Si le paramètre n'est pas présent dans le JSON ou que sa valeur est égale au mot "default", la météo va le considérer comme ayant une valeur non définie et va calculer sa valeur par défaut ( voir le chapitre Calcul de la valeur d'un paramètre en cascade ).
| Anchor | ||||
|---|---|---|---|---|
|
Calcul de la valeur d'un paramètre en cascade
La valeur d'un paramètre peut être définie à 3 niveaux différents :
- Dans le lien ( ce qui servira pour ce lien uniquement ) ;
- Dans le niveau "default_link" ( ce qui servira de valeur par défaut pour ce paramètre dans cette météo ) ;
- Dans les fichiers de configurations de la météo ( ces valeurs serviront alors de valeur par défaut de toutes les météos ) ;
La valeur d'un paramètre sera déterminée en parcourant les 3 niveaux dans l'ordre jusqu'à ce qu'une valeur définie soit trouvée :
- dans la partie JSON de la configuration du "link" ;
- dans la partie JSON de la configuration du "default_link" ;
- dans le "fichier de configuration".
| Info |
|---|
|
| Info |
|---|
Pour les notifications, il y a un quatrième niveau qui est celui de la météo. En effet si aucune configuration n'est présente sur le lien ou sur le niveau "default_link", alors il prendra la configuration, si existante, de la météo. |
La configuration des liens
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
"links": [
{
"link_name" : "external portal display",
"link_uuid" : "e214ce6ac1580cef86ddf7479ba9bf1d",
"link_protocol" : "protocol_from_webui",
"link_base_url" : "my.proxy:8080",
"link_external_part_url": "external",
"authentication_needed": true,
"info_bar": {
},
"notifications": {
}
},
...
]
...
} |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Texte | --- | --- | Le nom est obligatoire.
| ||||||||||||||||||||||||||||||||||||
| Texte | --- | --- | Correspond à l'identifiant unique du lien. Ne pas changer. Est automatiquement ajouté au lien si manquant. Il peut être personnalité, mais doit impérativement être unique parmi les liens ( voir la page Edition des liens externes - Edition - Météo ). | ||||||||||||||||||||||||||||||||||||
| Texte | --- | protocol_from_webui | Cette option vous permet de choisir via quel protocole le lien externe va être créé.
| ||||||||||||||||||||||||||||||||||||
| Booléen | --- | default |
| ||||||||||||||||||||||||||||||||||||
| Texte | --- | default | Cette option vous permet de modifier la base URL d'accès aux liens externes.
Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009 Où :
Le caractère / et les autres caractères interdits dans les URL ne sont pas autorisés dans ce paramètre. Exemple de caractères interdit : !,#,$,&,',(,),*,+,,/,:,;,=,?,@,[,],<,>, caractères avec des accents… Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade | ||||||||||||||||||||||||||||||||||||
| Texte | --- | default | Cette option vous permet de modifier le chemin d'accès aux liens externes, c'est une partie personnalisable de l'url qui sera partagée ( voir la page Edition des liens externes - Edition - Météo ).
Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009 Où :
Le caractère / et les autres caractères interdits dans les URL ne sont pas autorisés dans ce paramètre. Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade | ||||||||||||||||||||||||||||||||||||
| Objet | --- | --- | Permet de définir un paramétrage pour la barre d'information uniquement pour ce lien. Voir ci-dessous pour le paramétrage d'une barre d'information. | ||||||||||||||||||||||||||||||||||||
| Objet | --- | --- | Permet de définir les paramètres de notifications pour ce lien uniquement. Voir ci dessous pour le paramètre des notifications. |
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
"info_bar": {
"position" : "top",
"background_color": "#343434",
"logo_displayed" : false,
"refresh" : {
"chrono_displayed": true,
"generation_time_displayed" : false
}
}
...
} |
| Nom | Type | Unité | Défaut | Commentaire | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Texte | --- | default | Position de la barre d'information .
Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade. | |||||||||
| Couleur Web | --- | default | Couleur de la barre d'information. Le format de la valeur est une couleur web ( Voir : https://en.wikipedia.org/wiki/Web_colors ) Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade. | |||||||||
| Booléen | --- | default | Option d'affichage du logo Shinken.
Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade | |||||||||
| --- | --- | --- | Options d'affichage des informations de rafraichissement ( voir le paragraphe Option d'affichage des informations de rafraichissement ) |
| Info |
|---|
Si la barre d'information est vide ( tous les éléments qui peuvent être affichés sont à hidden ou false ), elle ne sera pas présente. |
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
"refresh" : {
"chrono_displayed": true,
"generation_time_displayed" : false
}
...
} |
| Nom | Type | Unité | Défaut | Commentaire | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Booléen | --- | default | Affiche sur la barre d'information ( à droite ) l'icône d'horloge indiquant le temps restant avant le prochain rafraichissement ( heure de génération de la page ).
| |||||||
| Booléen | --- | default | Affiche sur la barre d'information ( à droite ) le texte indiquant l'heure du dernier rafraichissement ( heure de génération de la page ).
|
| Anchor | ||||
|---|---|---|---|---|
|
Le paramétrage des notifications suit un héritage particulier :
- En priorité, le paramétrage du lien est utilisé
- Si celui-ci n'est pas présent, celui du lien par défaut est utilisé
- Si celui-ci n'est pas présent, celui de la météo est utilisé
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
"notifications": {
"sound": {
"enabled": "default"
},
"visual": {
"blink": {
"enabled": "default"
}
}
}
... |
Définition des notifications sonores
Il est possible de paramétrer les notifications sonores de la météo en modifiant la partie "notifications" du JSON.
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
"notifications" : {
"sound": {
"enabled": "default"
},
...
}
... |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Booléen | --- | default |
|
Définition des notifications visuelles
Il est possible de paramétrer les notifications visuelles de la météo en modifiant la partie "notifications" du JSON. Ces notifications apparaissent sous la forme d'un clignotement de 3 secondes sur les éléments concernés par un changement d'état.
| Code Block | ||||
|---|---|---|---|---|
| ||||
...
"notifications" : {
...
"visual": {
"blink": {
}
},
...
}
... |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Booléen | --- | default |
|
La configuration du niveau "default_link" des liens
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
"default_link" : {
"link_protocol" : "protocol_from_webui",
"link_base_url" : "my.proxy:8080",
"link_external_part_url" : "external",
"authentication_needed" : true,
"links": [],
"info_bar": {
"position" : "top",
"background_color": "#343434",
"logo_displayed" : true,
"refresh" : {
"chrono_displayed": true,
"generation_time_displayed" : false
}
},
"notifications": {}
...
} |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| protocol_from_webui | Cette option vous permet de choisir via quel protocole le lien externe va être créé.
Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade | ||||||||||||||||||||||||||||||||||||||
| Texte | --- | L'url du Broker | Cette option vous permet de modifier la base de l'URL d'accès aux liens externes.
Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009 Où :
Le caractère / et les autres caractères interdits dans les URL, ne sont pas autorisés dans ce paramètre. Si la valeur default est définie, voir le chapitre Calcul de la valeur d'un paramètre en cascade | ||||||||||||||||||||||||||||||||||||
| Texte | --- | external | Cette option vous permet de modifier le chemin d'accès aux liens externesliens externes, c'est une partie personnalisable de l'url qui sera partagée ( voir la page Edition des liens externes - Edition - Météo ).
Exemple d'URL : http://localhost:7767/service-weather/external/abcd01/xyz009
Le caractère / et les autres caractères interdits dans les URL ne sont pas autorisés dans ce paramètre.
| ||||||||||||||||||||||||||||||||||||
| Booléen | --- | default | Cette option permet de définir si une authentification est nécessaire pour accéder aux liens externes par défaut. Ce paramètre peut être écrasé pour chaque lien en fonction de leur configuration.
| ||||||||||||||||||||||||||||||||||||
| Objet | --- | --- | Configuration qui sera utilisée par défaut par tous les liens externes. Il est possible pour chaque lien de redéfinir leur propre configuration afin de ne pas utiliser celle-ci. Pour plus d'informations sur la configuration d'une barre d'information, voir le chapitre La configuration de la barre d'information des liens | ||||||||||||||||||||||||||||||||||||
| Objet | --- | --- | Configuration qui sera utilisée par défaut par tous les liens externes. Il est possible pour chaque lien de redéfinir leur propre configuration afin de ne pas utiliser celle-ci. Pour plus d'informations sur la configuration des notifications, voir le chapitre La configuration des notifications |
Gestion de l'authentification pour l'accès aux liens externes
Afin de limiter l'accès à la vue météo, il est possible de définir si le lien d'export est accessible aux personnes non authentifiées.
Un ensemble d'options permettant de paramétrer ce système est disponible dans le fichier JSON de la vue :
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
...
"users" : {
"owner_user" : {
"uuid": "user_uuid",
"name": "user_name"
},
},
"external_links": {
"default_link" : {
"authentication_needed" : true
},
"links": [
{
"authentication_needed": true
}
]
}
...
} |
Le champ qui nous intéresse intéressant est authentication_needed ( paramétrable dans chaque lien ).
| Info |
|---|
Le champ "owner_user" n'est pas encore pris en compte dans la version ( En cours de développement ). |
| Anchor | ||||
|---|---|---|---|---|
|
Exemples de dispositions de la barre information
Lien externe avec barre barre en bas, chrono et texte visibles
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
"position" : "bottom",
"background_color": "#000000",
"logo_displayed" : true,
"refresh" : {
"chrono_displayed": true,
"generation_time_displayed" : true
} |
| Panel |
|---|
Lien externe avec barre orange en haut, chrono et texte visibles
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
"position" : "top",
"background_color": "orange",
"logo_displayed" : true,
"refresh" : {
"chrono_displayed": true,
"generation_time_displayed" : true
} |
| Panel |
|---|