Action RS-232

Utilisez l'action device_operation pour exécuter à distance toute opération sur un périphérique que vous avez défini dans Broadsign Control Administrator.

Appelez l'action device_operation en utilisant l'une des méthodes 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) :

C:\Program Files\BroadSign\bsp\bin

• Ubuntu Linux :

  /opt/broadsign/suite/bsp/bin/

Pour définir le type de communication et les actions personnalisées, vous devrez mettre à jour le profil de configuration de votre lecteur. Pour plus d'informations, consultez L'onglet «Devices».

Définir le type de communication :

• Serial – La configuration est simple : spécifiez un nom qui représente le périphérique connecté au port série, et configurez le port série en conséquence. Choisissez le port COM, la vitesse, la taille en octets, la parité, le délai d'attente de lecture, le contrôle de flux et les bits d'arrêt appropriés à votre périphérique. Les paramètres exacts à utiliser dépendent des capacités de votre port série et du périphérique connecté. Consultez leurs manuels d'utilisation pour plus de détails. Les paramètres par défaut fonctionneront sur la plupart des appareils.

  Drain Bytes est un paramètre utile qui vide le nombre spécifié d'octets du port série avant d'exécuter toute commande RS232, garantissant ainsi sa propreté. Ceci est nécessaire pour prendre en charge certains écrans qui remplissent périodiquement la mémoire tampon de commandes RS232 avec des données erronées, empêchant ainsi le lecteur d'identifier correctement la réponse attendue pour une commande donnée.

  

• TCP – Si TCP est sélectionné, vous devrez saisir le nom d'hôte ou l'adresse IP du service TCP ainsi que le port auquel vous connecter.

  

Définir des actions personnalisées :

Pour les appareils nécessitant des opérations de contrôle non répertoriés dans l'ensemble d'actions par défaut de Broadsign, des actions personnalisées peuvent être définies à l'aide du type « Custom ».

Une application personnalisée peut utiliser les opérations par défaut et personnalisées de l'API Player en envoyant un message XML au port monitor_remote (2324).

Utiliser XML pour un fonctionnement par défaut du périphérique :

L'action device_operation peut être utilisée pour exécuter à distance n'importe quelle opération de périphérique déjà définie dans Broadsign Control Administrator.

Par exemple, en utilisant une commande Set Volume avec la valeur 35, le code XML devrait être :

<!-- SENT XML -->
<rc version="1" id="1" action="device_operation" name="set_volume" value="35" />\r\n\r\n
<!-- RECEIVED XML --><rc version="1" id="1">
<device_operation name="set_volume" value="35" status="1" return="1415BF4478" />
</rc>

L'indicateur d'état sera « 1 » lorsque l'opération sur le périphérique s'exécutera avec succès. Cela signifie que le code hexadécimal attendu a été renvoyé par le périphérique dès la première tentative, ou que l'opération de gestion des erreurs a pu se rétablir et s'exécuter avec succès.

Lorsque l'indicateur d'état est égal à « 0 », cela indique que l'opération a échoué.

Dans tous les cas, le code hexadécimal renvoyé pour la commande initiale (et non pour le gestionnaire d'erreurs) se trouvera dans l'attribut « return ».

Note : Vous devez terminer la requête avec \r\n\r\n.

Note : Toute opération de contrôle de périphérique exécutée en externe qui échoue produira un code standard d'incident Broadsign lié au contrôle de l'appareil. L'incident sera signalé au serveur, puis escaladé conformément au cadre de gestion des incidents et des seuils existant. Pour plus d'informations, consultez Types d'incidents et Seuils d'incident.

Utiliser XML pour un fonctionnement personnalisé du périphérique :

Lorsqu'une action personnalisée est invoquée via monitor_remote XML, « custom » sera utilisé pour le type d'action, tandis que la valeur sera une chaîne de caractères définie par l'utilisateur.

Par exemple:

<!-- SENT XML -->
<rc version="1" id="1" action="device_operation" name="custom" value="OPEN"/>\r\n\r\n
<!-- RECEIVED XML -->
<rc version="1" id="1">
<device_operation name="custom" value="OPEN" status="1" return="1415BF4478"/>
</rc>

Action RS-232 - 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.

Une application personnalisée peut utiliser les opérations par défaut et personnalisées de l'API Player en envoyant un message JSON au serveur WebSocket de monitor_remote (port 2326). Vous devrez activer le serveur WebSocket. Pour plus d'informations, consultez L'onglet «Remote Control».

Utiliser JSON pour un fonctionnement par défaut du périphérique :

L'action device_operation peut être utilisée pour exécuter à distance n'importe quelle opération de périphérique déjà définie dans Broadsign Control Administrator.

Par exemple, en utilisant une commande Set Volume avec la valeur 35, la requête JSON devrait être :

{
    "rc": {
        "version": "1",
        "id": "1",
        "action": "device_operation",
        "name": "set_volume",
        "value": "35"
    }
}

Le JSON reçu serait :

{
    "rc": {
        "device_operation": {
            "name": "set_volume",
            "value": "35",
            "status": "1",
            "return": "1415BF4478"
        },
        "version": "1",
        "id": "1"
    }
}

L'indicateur d'état sera « 1 » lorsque l'opération sur le périphérique s'exécutera avec succès. Cela signifie que le code hexadécimal attendu a été renvoyé par le périphérique dès la première tentative, ou que l'opération de gestion des erreurs a pu se rétablir et s'exécuter avec succès.

Lorsque l'indicateur d'état est égal à « 0 », cela indique que l'opération a échoué.

Dans tous les cas, le code hexadécimal renvoyé pour la commande initiale (et non pour le gestionnaire d'erreurs) se trouvera dans l'attribut « return ».

Toute opération de contrôle de périphérique exécutée en externe qui échoue produira un code standard d'incident Broadsign lié au contrôle de l'appareil. L'incident sera signalé au serveur, puis escaladé conformément au cadre de gestion des incidents et des seuils existant. Pour plus d'informations, consultez Types d'incidents et Seuils d'incident.

Utilisez JSON pour une opération personnalisée sur l'appareil :

Lorsqu'une action personnalisée est invoquée via monitor_remote JSON, « custom » sera utilisé pour le type d'action, tandis que la valeur sera une chaîne de caractères définie par l'utilisateur.

Par exemple :

{
    "rc": {
        "version": "1",
        "id": "1",
        "action": "device_operation",
        "name": "custom",
        "value": "OPEN"
    }
}

Le JSON reçu serait :

{
    "rc": {
        "device_operation": {
            "name": "custom",
            "value": "OPEN",
            "status": "1",
            "return": "1415BF4478"
        },
        "version": "1",
        "id": "1"
    }
}

Action RS-232 - 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.