Action de rapport de champ personnalisé
L'action Rapport de champ personnalisé permet d'ajouter des informations personnalisées dans le rapport de terrain d'un lecteur pour transférer des informations supplémentaires à partir des appareils.
Votre contenu dynamique peut invoquer l’action field_report à tout moment du cycle de lecture.
Broadsign Control Player enregistrera le contenu du custom-field qui apparaîtra dans l'onglet Field Report du panneau Service du lecteur. Voir L'onglet «Field Report».
Appelez l'action field_report en utilisant l'une des options suivantes :
Serveur WebSocket :
-
JSON – Vous pouvez transmettre des paramètres depuis votre fichier HTML5 à l’aide de JSON.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
Port 2324 :
- remote_action – Une application fournie avec Broadsign Control Player qui utilise la ligne de commande.
- XML – Si vous souhaitez développer vos propres applications, vous pouvez communiquer directement avec Broadsign Control Player API en utilisant XML.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
Note : L'action Déclencheurs est la seule exception à cette règle. Elle utilise le port 2325. Voir Action Triggers.
Vous pouvez appeler cette action sur Windows et Ubuntu Linux, et la trouver via les chemins suivants :
- Windows (64 bits) :
- Ubuntu Linux :
/opt/broadsign/suite/bsp/bin/
C:\Program Files\BroadSign\bsp\bin
Votre contenu dynamique peut invoquer l’action field_report à tout moment du cycle de lecture.
Par exemple, pour appeler field_report, tapez :
remote_action field_report --custom-field '<custom_json>'
Où:
- field_report est le type d'action
- custom-field est le nom du champ personnalisé
- <custom_json> contient des paires clé-valeur personnalisées écrites au format JSON, par exemple,
{"key1":"value1", "key2":value2"}. Les crochets <> ne sont pas obligatoires.
Broadsign Control Player enregistrera le contenu du custom-field qui apparaîtra dans l'onglet Field Report du panneau Service du lecteur. Voir L'onglet «Field Report».
Une application peut injecter des champs personnalisés dans le rapport de terrain en envoyant un message XML au port monitor_remote (2324).
<rc version="1" id="1" action="field_report" custom_field="<custom_json>"/>\r\n\r\n
Note : Vous devez terminer la requête avec \r\n\r\n.
Le lecteur répondra avec le document suivant :
<rc version="1" status="1" action="field_report" id="1" />
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
Action de rapport de champ personnalisé - Paramètres XML
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
| Paramètre | Description |
|---|---|
| version | La version est toujours 1. |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre; toujours field_report. |
| custom_field |
Personnalisez la valeur JSON souhaitée. <custom_json> contient des paires clé-valeur personnalisées écrites au format JSON, par exemple, Ce contenu apparaîtra dans votre rapport de terrain. |
Une application peut injecter des champs personnalisés dans le rapport de terrain en envoyant un message JSON au port 2326. Vous devrez activer le serveur WebSocket. Pour plus d'informations, voir L'onglet «Remote Control».
{
"rc": {
"version": "1",
"id": "1",
"action": "field_report",
"custom_field":" "<custom_json>",
}
}
Le lecteur répondra avec le document suivant :
{
"rc": {
"id": "1",
"version": "1",
"action": "field_report",
"status": "1"
}
}
Action de rapport de champ personnalisé - Paramètres JSON
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
| Paramètre | Description |
|---|---|
| version | La version est toujours 1. |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre; toujours field_report. |
| custom_field |
Personnalisez la valeur JSON souhaitée. <custom_json> contient des paires clé-valeur personnalisées écrites au format JSON, par exemple, Ce contenu apparaîtra dans votre rapport de terrain. |
