Versions Type Système d’exploitation Exigences Dépendances Configuration Données d’entrée Données de sortie Demandes et réponses de Modbus RTU Fichier journal local Licences Journal des modifications

Modbus-RTU adaptateur de protocole

Le composant adaptateur de Modbus-RTU protocole (aws.greengrass.Modbus) interroge les informations des périphériques Modbus RTU locaux.

Pour demander des informations à un périphérique Modbus RTU local doté de ce composant, publiez un message dans la rubrique à laquelle ce composant est abonné. Dans le message, spécifiez la demande Modbus RTU à envoyer à un appareil. Ce composant publie ensuite une réponse contenant le résultat de la demande Modbus RTU.

Note

Ce composant fournit des fonctionnalités similaires à celles du connecteur de l'adaptateur de protocole Modbus RTU de la version V1. AWS IoT Greengrass Pour plus d'informations, consultez la section Connecteur de l'adaptateur de protocole Modbus RTU dans le Guide du développeur AWS IoT Greengrass V1.

Versions

Les versions de ce composant sont les suivantes :

2.1.x
2.0.x

Type

Ce composant est un composant Lambda (aws.greengrass.lambda). Le noyau Greengrass exécute la fonction Lambda de ce composant à l'aide du composant Lambda launcher.

Pour de plus amples informations, veuillez consulter Types de composant.

Système d’exploitation

Ce composant ne peut être installé que sur les appareils principaux de Linux.

Exigences

Ce composant répond aux exigences suivantes :

Votre appareil principal doit répondre aux exigences pour exécuter les fonctions Lambda. Si vous souhaitez que le périphérique principal exécute des fonctions Lambda conteneurisées, il doit répondre aux exigences requises. Pour de plus amples informations, veuillez consulter Exigences relatives à la fonction Lambda.
https://www.python.org/La version 3.7 de Python a été installée sur le périphérique principal et ajoutée à la variable d'environnement PATH.
Connexion physique entre le périphérique AWS IoT Greengrass principal et les appareils Modbus. Le périphérique principal doit être connecté physiquement au réseau Modbus RTU via un port série, tel qu'un port USB.
Pour recevoir les données de sortie de ce composant, vous devez fusionner la mise à jour de configuration suivante pour l'ancien composant du routeur d'abonnement (aws.greengrass.LegacySubscriptionRouter) lorsque vous déployez ce composant. Cette configuration spécifie la rubrique dans laquelle ce composant publie les réponses.
Legacy subscription router v2.1.x
```
{
  "subscriptions": {
    "aws-greengrass-modbus": {
      "id": "aws-greengrass-modbus",
      "source": "component:aws.greengrass.Modbus",
      "subject": "modbus/adapter/response",
      "target": "cloud"
    }
  }
}
```
Legacy subscription router v2.0.x
```
{
  "subscriptions": {
    "aws-greengrass-modbus": {
      "id": "aws-greengrass-modbus",
      "source": "arn:aws:lambda:region:aws:function:aws-greengrass-modbus:version",
      "subject": "modbus/adapter/response",
      "target": "cloud"
    }
  }
}
```
regionRemplacez-le par Région AWS celui que vous utilisez.

versionRemplacez-la par la version de la fonction Lambda exécutée par ce composant. Pour trouver la version de la fonction Lambda, vous devez consulter la recette de la version de ce composant que vous souhaitez déployer. Ouvrez la page de détails de ce composant dans la AWS IoT Greengrass console et recherchez la paire clé-valeur de la fonction Lambda. Cette paire clé-valeur contient le nom et la version de la fonction Lambda.
Important
Vous devez mettre à jour la version de la fonction Lambda sur l'ancien routeur d'abonnement chaque fois que vous déployez ce composant. Cela garantit que vous utilisez la version de fonction Lambda appropriée pour la version du composant que vous déployez.
Pour de plus amples informations, veuillez consulter Créer des déploiements.
L'adaptateur de Modbus-RTU protocole est pris en charge pour fonctionner dans un VPC.

Dépendances

Lorsque vous déployez un composant, déploie AWS IoT Greengrass également des versions compatibles de ses dépendances. Cela signifie que vous devez répondre aux exigences relatives au composant et à toutes ses dépendances pour pouvoir le déployer avec succès. Cette section répertorie les dépendances pour les versions publiées de ce composant et les contraintes de version sémantiques qui définissent les versions des composants pour chaque dépendance. Vous pouvez également consulter les dépendances pour chaque version du composant dans la AWS IoT Greengrass console. Sur la page des détails des composants, recherchez la liste des dépendances.

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,16,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,15,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,14,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,13,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,12,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,11,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,10,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,9,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,8,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,7,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,6,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,5,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,4,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,3,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,0 < 2,2,0	Stricte
Lanceur Lambda	^2,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	^2,0,0	Flexible
Service d'échange de jetons	^2,0,0	Stricte

Dépendance	Versions compatibles	Type de dépendance
Noyau Greengrass	> = 2,0,3 < 2,1,0	Stricte
Lanceur Lambda	> = 1,0,0	Stricte
Environnements d'exécution (runtimes) Lambda	>=1,0,0	Flexible
Service d'échange de jetons	> = 1,0,0	Stricte

Pour plus d'informations sur les dépendances des composants, consultez la référence de la recette des composants.

Configuration

Ce composant fournit les paramètres de configuration suivants que vous pouvez personnaliser lorsque vous déployez le composant.

Note

La configuration par défaut de ce composant inclut les paramètres de la fonction Lambda. Nous vous recommandons de modifier uniquement les paramètres suivants pour configurer ce composant sur vos appareils.

v2.1.x

lambdaParams

Objet contenant les paramètres de la fonction Lambda de ce composant. Cet objet contient les informations suivantes :

EnvironmentVariables

Objet contenant les paramètres de la fonction Lambda. Cet objet contient les informations suivantes :

ModbusLocalPort

Le chemin absolu vers le port série Modbus physique du périphérique principal, tel que/dev/ttyS2.

Pour exécuter ce composant dans un conteneur, vous devez définir ce chemin en tant que périphérique système (entréecontainerParams.devices) auquel le composant peut accéder. Ce composant s'exécute dans un conteneur par défaut.

Note

Ce composant doit avoir read/write accès à l'appareil.

ModbusBaudRate

(Facultatif) Une valeur de chaîne qui spécifie le débit en bauds pour les communications série avec les périphériques Modbus TCP locaux.

Valeur par défaut : 9600

ModbusByteSize

(Facultatif) Valeur de chaîne qui spécifie la taille d'un octet dans une communication série avec des périphériques Modbus TCP locaux. Choisissez5, 67, ou 8 bits.

Valeur par défaut : 8

ModbusParity

(Facultatif) Mode de parité à utiliser pour vérifier l'intégrité des données dans les communications série avec des périphériques Modbus TCP locaux.

E— Vérifiez l'intégrité des données avec une parité uniforme.
O— Vérifiez l'intégrité des données avec une parité impaire.
N— Ne vérifiez pas l'intégrité des données.

Valeur par défaut : N

ModbusStopBits

(Facultatif) Valeur de chaîne qui spécifie le nombre de bits indiquant la fin d'un octet dans une communication série avec des périphériques Modbus TCP locaux.

Valeur par défaut : 1

containerMode

(Facultatif) Mode de conteneurisation pour ce composant. Sélectionnez l’une des options suivantes :

GreengrassContainer— Le composant s'exécute dans un environnement d'exécution isolé à l'intérieur du AWS IoT Greengrass conteneur.

Si vous spécifiez cette option, vous devez spécifier un périphérique système (incontainerParams.devices) pour permettre au conteneur d'accéder au périphérique Modbus.
NoContainer— Le composant ne s'exécute pas dans un environnement d'exécution isolé.

Valeur par défaut : GreengrassContainer

containerParams

(Facultatif) Objet contenant les paramètres de conteneur pour ce composant. Le composant utilise ces paramètres si vous spécifiez GreengrassContainer pourcontainerMode.

Cet objet contient les informations suivantes :

memorySize

(Facultatif) La quantité de mémoire (en kilo-octets) à allouer au composant.

La valeur par défaut est 512 Mo (525 312 Ko).

devices

(Facultatif) Objet qui spécifie les périphériques système auxquels le composant peut accéder dans un conteneur.

Important

Pour exécuter ce composant dans un conteneur, vous devez spécifier le périphérique système que vous configurez dans la variable d'ModbusLocalPortenvironnement.

Cet objet contient les informations suivantes :

0— Il s'agit d'un index de tableau sous forme de chaîne.

Objet contenant les informations suivantes :

path

Le chemin vers le périphérique système sur le périphérique principal. Elle doit avoir la même valeur que celle pour laquelle vous configurezModbusLocalPort.

permission

(Facultatif) L'autorisation d'accéder au périphérique système depuis le conteneur. Cette valeur doit êtrerw, ce qui indique que le composant a read/write accès au périphérique système.

Valeur par défaut : rw

addGroupOwner

(Facultatif) S'il faut ajouter ou non le groupe de systèmes qui exécute le composant en tant que propriétaire du périphérique système.

Valeur par défaut : true

pubsubTopics

(Facultatif) Objet contenant les rubriques auxquelles le composant s'abonne pour recevoir des messages. Vous pouvez spécifier chaque sujet et indiquer si le composant s'abonne à des sujets MQTT depuis AWS IoT Core ou à des sujets locaux publish/subscribe .

Cet objet contient les informations suivantes :

0— Il s'agit d'un index de tableau sous forme de chaîne.

Objet contenant les informations suivantes :

type

(Facultatif) Type de publish/subscribe messagerie que ce composant utilise pour s'abonner aux messages. Sélectionnez l’une des options suivantes :

PUB_SUB— Abonnez-vous aux publish/subscribe messages locaux. Si vous choisissez cette option, la rubrique ne peut pas contenir de caractères génériques MQTT. Pour plus d'informations sur l'envoi de messages à partir d'un composant personnalisé lorsque vous spécifiez cette option, consultezPublier/souscrire des messages locaux.
IOT_CORE— Abonnez-vous aux messages AWS IoT Core MQTT. Si vous choisissez cette option, la rubrique peut contenir des caractères génériques MQTT. Pour plus d'informations sur la façon d'envoyer des messages à partir de composants personnalisés lorsque vous spécifiez cette option, consultezPublish/subscribe AWS IoT Core Messages MQTT.

Valeur par défaut : PUB_SUB

topic

(Facultatif) Rubrique à laquelle le composant est abonné pour recevoir des messages. Si vous spécifiez IotCore pourtype, vous pouvez utiliser des caractères génériques MQTT (+et#) dans cette rubrique.

Exemple Exemple : mise à jour de la fusion de configurations (mode conteneur)


{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "ModbusLocalPort": "/dev/ttyS2"
    }
  },
  "containerMode": "GreengrassContainer",
  "containerParams": {
    "devices": {
      "0": {
        "path": "/dev/ttyS2",
        "permission": "rw",
        "addGroupOwner": true
      }
    }
  }
}

Exemple Exemple : mise à jour de la fusion de configurations (pas de mode conteneur)


{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "ModbusLocalPort": "/dev/ttyS2"
    }
  },
  "containerMode": "NoContainer"
}

v2.0.x

lambdaParams

Objet contenant les paramètres de la fonction Lambda de ce composant. Cet objet contient les informations suivantes :

EnvironmentVariables

Objet contenant les paramètres de la fonction Lambda. Cet objet contient les informations suivantes :

ModbusLocalPort

Le chemin absolu vers le port série Modbus physique du périphérique principal, tel que/dev/ttyS2.

Note

Ce composant doit avoir read/write accès à l'appareil.

containerMode

(Facultatif) Mode de conteneurisation pour ce composant. Sélectionnez l’une des options suivantes :

GreengrassContainer— Le composant s'exécute dans un environnement d'exécution isolé à l'intérieur du AWS IoT Greengrass conteneur.

Si vous spécifiez cette option, vous devez spécifier un périphérique système (incontainerParams.devices) pour permettre au conteneur d'accéder au périphérique Modbus.
NoContainer— Le composant ne s'exécute pas dans un environnement d'exécution isolé.

Valeur par défaut : GreengrassContainer

containerParams

(Facultatif) Objet contenant les paramètres de conteneur pour ce composant. Le composant utilise ces paramètres si vous spécifiez GreengrassContainer pourcontainerMode.

Cet objet contient les informations suivantes :

memorySize

(Facultatif) La quantité de mémoire (en kilo-octets) à allouer au composant.

La valeur par défaut est 512 Mo (525 312 Ko).

devices

(Facultatif) Objet qui spécifie les périphériques système auxquels le composant peut accéder dans un conteneur.

Important

Pour exécuter ce composant dans un conteneur, vous devez spécifier le périphérique système que vous configurez dans la variable d'ModbusLocalPortenvironnement.

Cet objet contient les informations suivantes :

0— Il s'agit d'un index de tableau sous forme de chaîne.

Objet contenant les informations suivantes :

path

Le chemin vers le périphérique système sur le périphérique principal. Elle doit avoir la même valeur que celle pour laquelle vous configurezModbusLocalPort.

permission

(Facultatif) L'autorisation d'accéder au périphérique système depuis le conteneur. Cette valeur doit êtrerw, ce qui indique que le composant a read/write accès au périphérique système.

Valeur par défaut : rw

addGroupOwner

(Facultatif) S'il faut ajouter ou non le groupe de systèmes qui exécute le composant en tant que propriétaire du périphérique système.

Valeur par défaut : true

pubsubTopics

Cet objet contient les informations suivantes :

0— Il s'agit d'un index de tableau sous forme de chaîne.

Objet contenant les informations suivantes :

type

(Facultatif) Type de publish/subscribe messagerie que ce composant utilise pour s'abonner aux messages. Sélectionnez l’une des options suivantes :

PUB_SUB— Abonnez-vous aux publish/subscribe messages locaux. Si vous choisissez cette option, la rubrique ne peut pas contenir de caractères génériques MQTT. Pour plus d'informations sur l'envoi de messages à partir d'un composant personnalisé lorsque vous spécifiez cette option, consultezPublier/souscrire des messages locaux.
IOT_CORE— Abonnez-vous aux messages AWS IoT Core MQTT. Si vous choisissez cette option, la rubrique peut contenir des caractères génériques MQTT. Pour plus d'informations sur la façon d'envoyer des messages à partir de composants personnalisés lorsque vous spécifiez cette option, consultezPublish/subscribe AWS IoT Core Messages MQTT.

Valeur par défaut : PUB_SUB

topic

Exemple Exemple : mise à jour de la fusion de configurations (mode conteneur)


{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "ModbusLocalPort": "/dev/ttyS2"
    }
  },
  "containerMode": "GreengrassContainer",
  "containerParams": {
    "devices": {
      "0": {
        "path": "/dev/ttyS2",
        "permission": "rw",
        "addGroupOwner": true
      }
    }
  }
}

Exemple Exemple : mise à jour de la fusion de configurations (pas de mode conteneur)


{
  "lambdaExecutionParameters": {
    "EnvironmentVariables": {
      "ModbusLocalPort": "/dev/ttyS2"
    }
  },
  "containerMode": "NoContainer"
}

Données d’entrée

Ce composant accepte les paramètres de requête Modbus RTU sur le sujet suivant et envoie la requête Modbus RTU au périphérique. Par défaut, ce composant s'abonne aux publish/subscribe messages locaux. Pour plus d'informations sur la façon de publier des messages sur ce composant à partir de vos composants personnalisés, consultezPublier/souscrire des messages locaux.

Rubrique par défaut (locale publish/subscribe) : modbus/adapter/request

Le message accepte les propriétés suivantes. Les messages d'entrée doivent être au format JSON.

request

Les paramètres de la demande Modbus RTU à envoyer.

La forme du message de demande dépend du type de demande Modbus RTU qu'il représente. Les propriétés suivantes sont requises pour toutes les demandes.

Type : object qui contient les informations suivantes :

operation

Le nom de l'opération à exécuter. Par exemple, spécifiez ReadCoilsRequest de lire les bobines sur un périphérique Modbus RTU. Pour plus d'informations sur les opérations prises en charge, consultezDemandes et réponses de Modbus RTU.

Type : string

device

L'appareil cible de la requête.

Cette valeur doit être un entier compris entre 0 et247.

Type : integer

Les autres paramètres à inclure dans la demande dépendent de l'opération. Ce composant gère le contrôle de redondance cyclique (CRC) pour vérifier les demandes de données pour vous.

Note

Si votre demande inclut une address propriété, vous devez spécifier sa valeur sous forme d'entier. Par exemple, "address": 1.

id

ID arbitraire de la demande. Utilisez cette propriété pour mapper une demande d'entrée à une réponse de sortie. Lorsque vous spécifiez cette propriété, le composant définit cette valeur dans l'objet de réponse. id

Type : string

Exemple Exemple d'entrée : demande de lecture de bobines


{
  "request": {
    "operation": "ReadCoilsRequest",
    "device": 1,
    "address": 1,
    "count": 1
  },
  "id": "MyRequest"
}

Données de sortie

Ce composant publie les réponses sous forme de données de sortie sur la rubrique MQTT suivante par défaut. Vous devez spécifier cette rubrique subject dans la configuration de l'ancien composant de routeur d'abonnement. Pour plus d'informations sur la façon de s'abonner à des messages sur ce sujet dans vos composants personnalisés, consultezPublish/subscribe AWS IoT Core Messages MQTT.

Rubrique par défaut (AWS IoT Core MQTT) : modbus/adapter/response

La forme du message de réponse dépend de l'opération de demande et de l'état de la réponse. Pour obtenir des exemples, consultez Exemples de demandes et de réponses.

Chaque réponse inclut les propriétés suivantes :

response

La réponse du périphérique Modbus RTU.

Type : object qui contient les informations suivantes :

status

Le statut d'une demande. Le statut peut avoir l'une des valeurs suivantes :

Success— La demande était valide, le composant l'a envoyée au réseau Modbus RTU et le réseau Modbus RTU a renvoyé une réponse.
Exception— La demande était valide, le composant l'a envoyée au réseau Modbus RTU et le réseau Modbus RTU a renvoyé une exception. Pour de plus amples informations, veuillez consulter Statut de la réponse : Exception.
No Response— La demande n'était pas valide et le composant a détecté l'erreur avant d'envoyer la demande au réseau Modbus RTU. Pour de plus amples informations, veuillez consulter Statut de la réponse : Pas de réponse.

operation

L'opération demandée par le composant.

device

L'appareil sur lequel le composant a envoyé la demande.

payload

La réponse du périphérique Modbus RTU. Si status c'est le casNo Response, cet objet contient uniquement une error propriété avec la description de l'erreur (par exemple,[Input/Output] No Response received from the remote unit).

id

L'ID de la demande, que vous pouvez utiliser pour identifier quelle réponse correspond à quelle demande.

Note

Une réponse pour une opération d'écriture est simplement un écho de la demande. Bien que les réponses écrites ne contiennent pas d'informations significatives, il est recommandé de vérifier l'état de la réponse pour voir si la demande aboutit ou échoue.

Exemple Exemple de sortie : réussite


{
  "response" : {
    "status" : "success",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "function_code": 1,
      "bits": [1]
    }
  },
  "id" : "MyRequest"
}

Exemple Exemple de sortie : échec


{
  "response" : {
    "status" : "fail",
    "error_message": "Internal Error",
    "error": "Exception",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "function_code": 129,
      "exception_code": 2
    }
  },
  "id" : "MyRequest"
}

Pour obtenir plus d’exemples, consultez Exemples de demandes et de réponses.

Demandes et réponses de Modbus RTU

Ce connecteur accepte les paramètres de demande de Modbus RTU en tant que données d'entrée et publie les réponses en tant que données de sortie.

Les opérations communes suivantes sont prises en charge.

Nom de l'opération dans la demande	Code de fonction dans la réponse
ReadCoilsRequest	01
ReadDiscreteInputsRequest	02
ReadHoldingRegistersRequest	03
ReadInputRegistersRequest	04
WriteSingleCoilRequest	05
WriteSingleRegisterRequest	06
WriteMultipleCoilsRequest	15
WriteMultipleRegistersRequest	16
MaskWriteRegisterRequest	22
ReadWriteMultipleRegistersRequest	23

Voici des exemples de demandes et de réponses pour les opérations prises en charge.

Bobines de lecture

Exemple de requête :


{
  "request": {
    "operation": "ReadCoilsRequest",
    "device": 1,
    "address": 1,
    "count": 1
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "function_code": 1,
      "bits": [1]
    }
  },
  "id" : "TestRequest"
}

Lire les entrées discrètes

Exemple de requête :


{
  "request": {
    "operation": "ReadDiscreteInputsRequest",
    "device": 1,
    "address": 1,
    "count": 1
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "ReadDiscreteInputsRequest",
    "payload": {
      "function_code": 2,
      "bits": [1]
    }
  },
  "id" : "TestRequest"
}

Lire les registres de conservation

Exemple de requête :


{
  "request": {
    "operation": "ReadHoldingRegistersRequest",
    "device": 1,
    "address": 1,
    "count": 1
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "ReadHoldingRegistersRequest",
    "payload": {
      "function_code": 3,
      "registers": [20,30]
    }
  },
  "id" : "TestRequest"
}

Lire les registres d'entrée

Exemple de requête :


{
  "request": {
    "operation": "ReadInputRegistersRequest",
    "device": 1,
    "address": 1,
    "count": 1
  },
  "id": "TestRequest"
}

Écrire une bobine unique

Exemple de requête :


{
  "request": {
    "operation": "WriteSingleCoilRequest",
    "device": 1,
    "address": 1,
    "value": 1
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "WriteSingleCoilRequest",
    "payload": {
      "function_code": 5,
      "address": 1,
      "value": true
    }
  },
  "id" : "TestRequest"
}

Écrire un registre unique

Exemple de requête :


{
  "request": {
    "operation": "WriteSingleRegisterRequest",
    "device": 1,
    "address": 1,
    "value": 1
  },
  "id": "TestRequest"
}

Écrire plusieurs bobines

Exemple de requête :


{
  "request": {
    "operation": "WriteMultipleCoilsRequest",
    "device": 1,
    "address": 1,
    "values": [1,0,0,1]
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "WriteMultipleCoilsRequest",
    "payload": {
      "function_code": 15,
      "address": 1,
      "count": 4
    }
  },
  "id" : "TestRequest"
}

Écrire plusieurs registres

Exemple de requête :


{
  "request": {
    "operation": "WriteMultipleRegistersRequest",
    "device": 1,
    "address": 1,
    "values": [20,30,10]
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "WriteMultipleRegistersRequest",
    "payload": {
      "function_code": 23,
      "address": 1,
      "count": 3
    }
  },
  "id" : "TestRequest"
}

Registre d'écriture de masques

Exemple de requête :


{
  "request": {
    "operation": "MaskWriteRegisterRequest",
    "device": 1,
    "address": 1,
    "and_mask": 175,
    "or_mask": 1
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "MaskWriteRegisterRequest",
    "payload": {
      "function_code": 22,
      "and_mask": 0,
      "or_mask": 8
    }
  },
  "id" : "TestRequest"
}

Lecture et écriture de plusieurs registres

Exemple de requête :


{
  "request": {
    "operation": "ReadWriteMultipleRegistersRequest",
    "device": 1,
    "read_address": 1,
    "read_count": 2,
    "write_address": 3,
    "write_registers": [20,30,40]
  },
  "id": "TestRequest"
}

Exemple de réponse :


{
  "response": {
    "status": "success",
    "device": 1,
    "operation": "ReadWriteMultipleRegistersRequest",
    "payload": {
      "function_code": 23,
      "registers": [10,20,10,20]
    }
  },
  "id" : "TestRequest"
}

Note

La réponse inclut les registres que le composant lit.

Des exceptions peuvent se produire lorsque le format de la demande est valide, mais la demande échoue. Dans ce cas, la réponse contient les informations suivantes :

Le status est réglé sur Exception.
Le function_code est égal au code de fonction de la requête + 128.
Le exception_code contient le code d'exception. Pour plus d'informations, consultez les codes d'exception de Modbus.

Exemple :


{
  "response": {
    "status": "fail",
    "error_message": "Internal Error",
    "error": "Exception",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "function_code": 129,
      "exception_code": 2
    }
  },
  "id": "TestRequest"
}

Ce connecteur effectue des vérifications de validation sur la demande Modbus. Par exemple, il vérifie les formats non valides et les champs manquants. Si la validation échoue, le connecteur n'envoie pas la demande. A la place, il renvoie une réponse qui contient les informations suivantes :

Le status est réglé sur No Response.
L'error contient la raison de l'erreur.
Le error_message contient le message de l'erreur.

Exemples :


{
  "response": {
    "status": "fail",
    "error_message": "Invalid address field. Expected <type 'int'>, got <type 'str'>",
    "error": "No Response",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "error": "Invalid address field. Expected Expected <type 'int'>, got <type 'str'>"
    }
  },
  "id": "TestRequest"
}

Si la demande vise un appareil qui n'existe pas ou si le réseau Modbus RTU ne fonctionne pas, vous pouvez obtenir une ModbusIOException qui utilise le format No Response.


{
  "response": {
    "status": "fail",
    "error_message": "[Input/Output] No Response received from the remote unit",
    "error": "No Response",
    "device": 1,
    "operation": "ReadCoilsRequest",
    "payload": {
      "error": "[Input/Output] No Response received from the remote unit"
    }
  },
  "id": "TestRequest"
}

Fichier journal local

Ce composant utilise le fichier journal suivant.


/greengrass/v2/logs/aws.greengrass.Modbus.log

Pour afficher les journaux de ce composant

Exécutez la commande suivante sur le périphérique principal pour afficher le fichier journal de ce composant en temps réel. /greengrass/v2Remplacez-le par le chemin d'accès au dossier AWS IoT Greengrass racine.
```
sudo tail -f /greengrass/v2/logs/aws.greengrass.Modbus.log
```

Licences

Ce composant inclut le tiers suivant software/licensing :

Licence pymodbus/BSD
Licence pyserial/BSD

Ce composant est publié dans le cadre du contrat de licence du logiciel Greengrass Core.

Journal des modifications

Le tableau suivant décrit les modifications apportées à chaque version du composant.

Version	Modifications
2.1.11	Version mise à jour pour la version 2.15.0 de Greengrass Nucleus.
2.1.10	Version mise à jour pour la version 2.14.0 de Greengrass Nucleus.
2.1.9	Version mise à jour pour la version 2.13.0 de Greengrass Nucleus.
2.1.8	Version mise à jour pour la version 2.12.0 de Greengrass Nucleus.
2.1.7	Version mise à jour pour la version 2.11.0 de Greengrass Nucleus.
2.1.6	Version mise à jour pour la version 2.10.0 de Greengrass Nucleus.
2.1.5	Corrections de bugs et améliorations Corrige un problème lié à l'`ReadDiscreteInput`opération.
2.1.4	Version mise à jour pour la version 2.9.0 de Greengrass Nucleus.
2.1.3	Version mise à jour pour la version 2.8.0 de Greengrass Nucleus.
2.1.2	Version mise à jour pour la version 2.7.0 de Greengrass Nucleus.
2.1.1	Version mise à jour pour la version 2.6.0 de Greengrass Nucleus.
2.1.0	Nouvelles fonctionnalités Ajoute les `ModbusStopBits` options `ModbusBaudRateModbusByteSize`,`ModbusParity`, et que vous pouvez spécifier pour configurer la communication série avec les périphériques Modbus RTU.
2.0.8	Version mise à jour pour la version 2.5.0 de Greengrass Nucleus.
2.0.7	Version mise à jour pour la version 2.4.0 de Greengrass Nucleus.
2.0.6	Version mise à jour pour la version 2.3.0 de Greengrass Nucleus.
2.0.5	Version mise à jour pour la version 2.2.0 de Greengrass Nucleus.
2.0.4	Version mise à jour pour la version 2.1.0 de Greengrass Nucleus.
2.0.3	Première version.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

TensorFlow Durée d'exécution allégée

Pont MQTT