Shadow Manager - AWS IoT Greengrass

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Shadow Manager

Le composant Shadow Manager (aws.greengrass.ShadowManager) active le service fantôme local sur votre appareil principal. Le service local d'ombre permet aux composants d'utiliser la communication entre processus pour interagir avec les ombres locales. Le composant Shadow Manager gère le stockage des documents d'ombre locaux et gère également la synchronisation des états d'ombre locaux avec le service AWS IoT Device Shadow.

Pour plus d'informations sur la manière dont les appareils Greengrass Core peuvent interagir avec les ombres, consultez. Interagissez avec les ombres de l'appareil

Versions

Les versions de ce composant sont les suivantes :

  • 2.3.x

  • 2.2.x

  • 2,1x

  • 2,0.x

Type

Ce composant est un composant de plugin (aws.greengrass.plugin). Le noyau Greengrass exécute ce composant dans la même machine virtuelle Java (JVM) que le noyau. Le noyau redémarre lorsque vous modifiez la version de ce composant sur le périphérique principal.

Ce composant utilise le même fichier journal que le noyau Greengrass. Pour plus d’informations, consultez AWS IoT GreengrassJournaux de surveillance.

Pour plus d’informations, consultez Types de composants.

Système d’exploitation

Ce composant peut être installé sur les appareils principaux qui exécutent les systèmes d'exploitation suivants :

  • Linux

  • Windows

Prérequis

Ce composant répond aux exigences suivantes :

  • (Facultatif) Pour synchroniser les ombres avec le service AWS IoT Device Shadow, la AWS IoT politique du périphérique principal de Greengrass doit autoriser les actions de politique AWS IoT Core parallèle suivantes :

    • iot:GetThingShadow

    • iot:UpdateThingShadow

    • iot:DeleteThingShadow

    Pour plus d'informations sur ces AWS IoT Core politiques, voir les actions AWS IoT Core politiques dans le Guide du AWS IoT développeur.

    Pour plus d'informations sur la AWS IoT politique minimale, voir AWS IoTPolitique minimale pour les appareils AWS IoT Greengrass V2 principaux

  • Le composant Shadow Manager est compatible pour s'exécuter dans un VPC.

Dépendances

Lorsque vous déployez un composant, il déploie AWS IoT Greengrass également des versions compatibles de ses dépendances. Cela signifie que vous devez satisfaire aux exigences relatives au composant et à toutes ses dépendances pour réussir le déploiement du composant. Cette section répertorie les dépendances des 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 de chaque version du composant dans la AWS IoT Greengrass console. Sur la page de détails du composant, recherchez la liste des dépendances.

2.3.5 – 2.3.8

Le tableau suivant répertorie les dépendances pour les versions 2.3.5 à 2.3.8 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,13,0 Flexible
2.3.3 and 2.3.4

Le tableau suivant répertorie les dépendances pour les versions 2.3.3 et 2.3.4 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,12,0 Flexible
2.3.2

Le tableau suivant répertorie les dépendances pour la version 2.3.2 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,11,0 Flexible
2.3.0 and 2.3.1

Le tableau suivant répertorie les dépendances pour les versions 2.3.0 et 2.3.1 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,1,0 Flexible
2.2.3 and 2.2.4

Le tableau suivant répertorie les dépendances pour les versions 2.2.3 et 2.2.4 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <3,0,0 Flexible
2.2.2

Le tableau suivant répertorie les dépendances pour la version 2.2.2 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,9,0 Flexible
2.2.1

Le tableau suivant répertorie les dépendances pour la version 2.2.1 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,8,0 Flexible
2.1.1 and 2.2.0

Le tableau suivant répertorie les dépendances pour les versions 2.1.1 et 2.2.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,7,0 Flexible
2.0.5 - 2.1.0

Le tableau suivant répertorie les dépendances pour les versions 2.0.5 à 2.1.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,6,0 Flexible
2.0.3 and 2.0.4

Le tableau suivant répertorie les dépendances pour les versions 2.0.3 et 2.0.4 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,5,0 Flexible
2.0.1 and 2.0.2

Le tableau suivant répertorie les dépendances pour les versions 2.0.1 et 2.0.2 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,4,0 Flexible
2.0.0

Le tableau suivant répertorie les dépendances pour la version 2.0.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,2,0 <2,3,0 Flexible

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.

2.3.x
strategy

(Facultatif) Stratégie utilisée par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal.

Cet objet contient les informations suivantes.

type

(Facultatif) Type de stratégie utilisé par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal. Sélectionnez parmi les options suivantes :

  • realTime— Synchronisez les ombres avec AWS IoT Core chaque mise à jour des ombres.

  • periodic— Synchronisez les ombres avec AWS IoT Core un intervalle régulier que vous spécifiez avec le paramètre delay de configuration.

Par défaut : realTime

delay

(Facultatif) Intervalle en secondes avec lequel ce composant synchronise les ombres AWS IoT Core, lorsque vous spécifiez la stratégie de periodic synchronisation.

Note

Ce paramètre est obligatoire si vous spécifiez la stratégie de periodic synchronisation.

synchronize

(Facultatif) Les paramètres de synchronisation qui déterminent la manière dont les ombres sont synchronisées avec. AWS Cloud

Note

Vous devez créer une mise à jour de configuration avec cette propriété pour synchroniser les ombres avec AWS Cloud.

Cet objet contient les informations suivantes.

coreThing

(Facultatif) Les ombres de l'appareil principal à synchroniser. Cet objet contient les informations suivantes.

classic

(Facultatif) Par défaut, le gestionnaire de shadow synchronise l'état local du shadow classique de votre appareil principal avec le AWS Cloud. Si vous ne souhaitez pas synchroniser le shadow classique de l'appareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres du périphérique principal nommées à synchroniser. Vous devez indiquer le nom exact des ombres.

Avertissement

Le AWS IoT Greengrass service utilise le AWSManagedGreengrassV2Deployment nom shadow pour gérer les déploiements qui ciblent des appareils principaux individuels. Cette ombre nommée est réservée à l'usage du AWS IoT Greengrass service. Ne mettez pas à jour ou ne supprimez pas cette ombre nommée.

shadowDocumentsMap

(Facultatif) Les ombres supplémentaires de l'appareil à synchroniser. L'utilisation de ce paramètre de configuration facilite la définition de documents fictifs. Nous vous recommandons d'utiliser ce paramètre à la place de l'shadowDocumentsobjet.

Note

Si vous spécifiez un shadowDocumentsMap objet, vous ne devez pas le spécifier. shadowDocuments

Chaque objet contient les informations suivantes :

thingName

La configuration d'ombre pour le ThingName pour cette configuration d'ombre.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

namedShadows

La liste des ombres nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

shadowDocuments

(Facultatif) La liste des ombres supplémentaires de l'appareil à synchroniser. Nous vous recommandons d'utiliser le shadowDocumentsMap paramètre à la place.

Note

Si vous spécifiez un shadowDocuments objet, vous ne devez pas le spécifier. shadowDocumentsMap

Chaque objet de cette liste contient les informations suivantes.

thingName

Nom de l'objet de l'appareil pour lequel les ombres doivent être synchronisées.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres de périphériques nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

direction

(Facultatif) La direction dans laquelle synchroniser les ombres entre le service d'ombre local et le AWS Cloud. Vous pouvez configurer cette option pour réduire la bande passante et les connexions au AWS Cloud. Sélectionnez parmi les options suivantes :

  • betweenDeviceAndCloud— Synchronise les ombres entre le service parallèle local et le AWS Cloud.

  • deviceToCloud— Envoyez des mises à jour instantanées depuis le service parallèle local vers le AWS Cloud, et ignorez les mises à jour instantanées depuis le AWS Cloud.

  • cloudToDevice— Recevez des mises à jour fictives depuis le AWS Cloud, et n'envoyez pas de mises à jour fictives depuis le service parallèle local vers le AWS Cloud.

Par défaut : BETWEEN_DEVICE_AND_CLOUD

rateLimits

(Facultatif) Les paramètres qui déterminent les limites de débit pour les demandes de service parallèle.

Cet objet contient les informations suivantes.

maxOutboundSyncUpdatesPerSecond

(Facultatif) Nombre maximal de demandes de synchronisation par seconde transmises par l'appareil.

Par défaut : 100 requêtes/seconde

maxTotalLocalRequestsRate

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées au périphérique principal.

Par défaut : 200 requêtes/seconde

maxLocalRequestsPerSecondPerThing

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées pour chaque objet IoT connecté.

Par défaut : 20 requêtes/seconde pour chaque élément

Note

Ces paramètres de limites de débit définissent le nombre maximal de demandes par seconde pour le service parallèle local. Le nombre maximum de demandes par seconde pour le service AWS IoT Device Shadow dépend de votre Région AWS. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

shadowDocumentSizeLimitBytes

(Facultatif) Taille maximale autorisée de chaque document d'état JSON pour les ombres locales.

Si vous augmentez cette valeur, vous devez également augmenter la limite de ressources pour le document d'état JSON pour les ombres des nuages. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

Par défaut : 8192 octets

Maximum : 30720 octets

Exemple : mise à jour de la fusion de configurations

L'exemple suivant montre un exemple de mise à jour de fusion de configuration avec tous les paramètres de configuration disponibles pour le composant Shadow Manager.

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.2.x
strategy

(Facultatif) Stratégie utilisée par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal.

Cet objet contient les informations suivantes.

type

(Facultatif) Type de stratégie utilisé par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal. Sélectionnez parmi les options suivantes :

  • realTime— Synchronisez les ombres avec AWS IoT Core chaque mise à jour des ombres.

  • periodic— Synchronisez les ombres avec AWS IoT Core un intervalle régulier que vous spécifiez avec le paramètre delay de configuration.

Par défaut : realTime

delay

(Facultatif) Intervalle en secondes avec lequel ce composant synchronise les ombres AWS IoT Core, lorsque vous spécifiez la stratégie de periodic synchronisation.

Note

Ce paramètre est obligatoire si vous spécifiez la stratégie de periodic synchronisation.

synchronize

(Facultatif) Les paramètres de synchronisation qui déterminent la manière dont les ombres sont synchronisées avec. AWS Cloud

Note

Vous devez créer une mise à jour de configuration avec cette propriété pour synchroniser les ombres avec AWS Cloud.

Cet objet contient les informations suivantes.

coreThing

(Facultatif) Les ombres de l'appareil principal à synchroniser. Cet objet contient les informations suivantes.

classic

(Facultatif) Par défaut, le gestionnaire de shadow synchronise l'état local du shadow classique de votre appareil principal avec le AWS Cloud. Si vous ne souhaitez pas synchroniser le shadow classique de l'appareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres du périphérique principal nommées à synchroniser. Vous devez indiquer le nom exact des ombres.

Avertissement

Le AWS IoT Greengrass service utilise le AWSManagedGreengrassV2Deployment nom shadow pour gérer les déploiements qui ciblent des appareils principaux individuels. Cette ombre nommée est réservée à l'usage du AWS IoT Greengrass service. Ne mettez pas à jour ou ne supprimez pas cette ombre nommée.

shadowDocumentsMap

(Facultatif) Les ombres supplémentaires de l'appareil à synchroniser. L'utilisation de ce paramètre de configuration facilite la définition de documents fictifs. Nous vous recommandons d'utiliser ce paramètre à la place de l'shadowDocumentsobjet.

Note

Si vous spécifiez un shadowDocumentsMap objet, vous ne devez pas le spécifier. shadowDocuments

Chaque objet contient les informations suivantes :

thingName

La configuration d'ombre pour le ThingName pour cette configuration d'ombre.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

namedShadows

La liste des ombres nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

shadowDocuments

(Facultatif) La liste des ombres supplémentaires de l'appareil à synchroniser. Nous vous recommandons d'utiliser le shadowDocumentsMap paramètre à la place.

Note

Si vous spécifiez un shadowDocuments objet, vous ne devez pas le spécifier. shadowDocumentsMap

Chaque objet de cette liste contient les informations suivantes.

thingName

Nom de l'objet de l'appareil pour lequel les ombres doivent être synchronisées.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres de périphériques nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

direction

(Facultatif) La direction dans laquelle synchroniser les ombres entre le service d'ombre local et le AWS Cloud. Vous pouvez configurer cette option pour réduire la bande passante et les connexions au AWS Cloud. Sélectionnez parmi les options suivantes :

  • betweenDeviceAndCloud— Synchronise les ombres entre le service parallèle local et le AWS Cloud.

  • deviceToCloud— Envoyez des mises à jour instantanées depuis le service parallèle local vers le AWS Cloud, et ignorez les mises à jour instantanées depuis le AWS Cloud.

  • cloudToDevice— Recevez des mises à jour fictives depuis le AWS Cloud, et n'envoyez pas de mises à jour fictives depuis le service parallèle local vers le AWS Cloud.

Par défaut : BETWEEN_DEVICE_AND_CLOUD

rateLimits

(Facultatif) Les paramètres qui déterminent les limites de débit pour les demandes de service parallèle.

Cet objet contient les informations suivantes.

maxOutboundSyncUpdatesPerSecond

(Facultatif) Nombre maximal de demandes de synchronisation par seconde transmises par l'appareil.

Par défaut : 100 requêtes/seconde

maxTotalLocalRequestsRate

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées au périphérique principal.

Par défaut : 200 requêtes/seconde

maxLocalRequestsPerSecondPerThing

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées pour chaque objet IoT connecté.

Par défaut : 20 requêtes/seconde pour chaque élément

Note

Ces paramètres de limites de débit définissent le nombre maximal de demandes par seconde pour le service parallèle local. Le nombre maximum de demandes par seconde pour le service AWS IoT Device Shadow dépend de votre Région AWS. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

shadowDocumentSizeLimitBytes

(Facultatif) Taille maximale autorisée de chaque document d'état JSON pour les ombres locales.

Si vous augmentez cette valeur, vous devez également augmenter la limite de ressources pour le document d'état JSON pour les ombres des nuages. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

Par défaut : 8192 octets

Maximum : 30720 octets

Exemple : mise à jour de la fusion de configurations

L'exemple suivant montre un exemple de mise à jour de fusion de configuration avec tous les paramètres de configuration disponibles pour le composant Shadow Manager.

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.1.x
strategy

(Facultatif) Stratégie utilisée par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal.

Cet objet contient les informations suivantes.

type

(Facultatif) Type de stratégie utilisé par ce composant pour synchroniser les ombres entre AWS IoT Core et le périphérique principal. Sélectionnez parmi les options suivantes :

  • realTime— Synchronisez les ombres avec AWS IoT Core chaque mise à jour des ombres.

  • periodic— Synchronisez les ombres avec AWS IoT Core un intervalle régulier que vous spécifiez avec le paramètre delay de configuration.

Par défaut : realTime

delay

(Facultatif) Intervalle en secondes avec lequel ce composant synchronise les ombres AWS IoT Core, lorsque vous spécifiez la stratégie de periodic synchronisation.

Note

Ce paramètre est obligatoire si vous spécifiez la stratégie de periodic synchronisation.

synchronize

(Facultatif) Les paramètres de synchronisation qui déterminent la manière dont les ombres sont synchronisées avec. AWS Cloud

Note

Vous devez créer une mise à jour de configuration avec cette propriété pour synchroniser les ombres avec AWS Cloud.

Cet objet contient les informations suivantes.

coreThing

(Facultatif) Les ombres de l'appareil principal à synchroniser. Cet objet contient les informations suivantes.

classic

(Facultatif) Par défaut, le gestionnaire de shadow synchronise l'état local du shadow classique de votre appareil principal avec le AWS Cloud. Si vous ne souhaitez pas synchroniser le shadow classique de l'appareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres du périphérique principal nommées à synchroniser. Vous devez indiquer le nom exact des ombres.

Avertissement

Le AWS IoT Greengrass service utilise le AWSManagedGreengrassV2Deployment nom shadow pour gérer les déploiements qui ciblent des appareils principaux individuels. Cette ombre nommée est réservée à l'usage du AWS IoT Greengrass service. Ne mettez pas à jour ou ne supprimez pas cette ombre nommée.

shadowDocumentsMap

(Facultatif) Les ombres supplémentaires de l'appareil à synchroniser. L'utilisation de ce paramètre de configuration facilite la définition de documents fictifs. Nous vous recommandons d'utiliser ce paramètre à la place de l'shadowDocumentsobjet.

Note

Si vous spécifiez un shadowDocumentsMap objet, vous ne devez pas le spécifier. shadowDocuments

Chaque objet contient les informations suivantes :

thingName

La configuration d'ombre pour le ThingName pour cette configuration d'ombre.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

namedShadows

La liste des ombres nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

shadowDocuments

(Facultatif) La liste des ombres supplémentaires de l'appareil à synchroniser. Nous vous recommandons d'utiliser le shadowDocumentsMap paramètre à la place.

Note

Si vous spécifiez un shadowDocuments objet, vous ne devez pas le spécifier. shadowDocumentsMap

Chaque objet de cette liste contient les informations suivantes.

thingName

Nom de l'objet de l'appareil pour lequel les ombres doivent être synchronisées.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres de périphériques nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

rateLimits

(Facultatif) Les paramètres qui déterminent les limites de débit pour les demandes de service parallèle.

Cet objet contient les informations suivantes.

maxOutboundSyncUpdatesPerSecond

(Facultatif) Nombre maximal de demandes de synchronisation par seconde transmises par l'appareil.

Par défaut : 100 requêtes/seconde

maxTotalLocalRequestsRate

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées au périphérique principal.

Par défaut : 200 requêtes/seconde

maxLocalRequestsPerSecondPerThing

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées pour chaque objet IoT connecté.

Par défaut : 20 requêtes/seconde pour chaque élément

Note

Ces paramètres de limites de débit définissent le nombre maximal de demandes par seconde pour le service parallèle local. Le nombre maximum de demandes par seconde pour le service AWS IoT Device Shadow dépend de votre Région AWS. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

shadowDocumentSizeLimitBytes

(Facultatif) Taille maximale autorisée de chaque document d'état JSON pour les ombres locales.

Si vous augmentez cette valeur, vous devez également augmenter la limite de ressources pour le document d'état JSON pour les ombres des nuages. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

Par défaut : 8192 octets

Maximum : 30720 octets

Exemple : mise à jour de la fusion de configurations

L'exemple suivant montre un exemple de mise à jour de fusion de configuration avec tous les paramètres de configuration disponibles pour le composant Shadow Manager.

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.0.x
synchronize

(Facultatif) Les paramètres de synchronisation qui déterminent la manière dont les ombres sont synchronisées avec. AWS Cloud

Note

Vous devez créer une mise à jour de configuration avec cette propriété pour synchroniser les ombres avec AWS Cloud.

Cet objet contient les informations suivantes.

coreThing

(Facultatif) Les ombres de l'appareil principal à synchroniser. Cet objet contient les informations suivantes.

classic

(Facultatif) Par défaut, le gestionnaire de shadow synchronise l'état local du shadow classique de votre appareil principal avec le AWS Cloud. Si vous ne souhaitez pas synchroniser le shadow classique de l'appareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres du périphérique principal nommées à synchroniser. Vous devez indiquer le nom exact des ombres.

Avertissement

Le AWS IoT Greengrass service utilise le AWSManagedGreengrassV2Deployment nom shadow pour gérer les déploiements qui ciblent des appareils principaux individuels. Cette ombre nommée est réservée à l'usage du AWS IoT Greengrass service. Ne mettez pas à jour ou ne supprimez pas cette ombre nommée.

shadowDocumentsMap

(Facultatif) Les ombres supplémentaires de l'appareil à synchroniser. L'utilisation de ce paramètre de configuration facilite la définition de documents fictifs. Nous vous recommandons d'utiliser ce paramètre à la place de l'shadowDocumentsobjet.

Note

Si vous spécifiez un shadowDocumentsMap objet, vous ne devez pas le spécifier. shadowDocuments

Chaque objet contient les informations suivantes :

thingName

La configuration d'ombre pour le ThingName pour cette configuration d'ombre.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

namedShadows

La liste des ombres nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

shadowDocuments

(Facultatif) La liste des ombres supplémentaires de l'appareil à synchroniser. Nous vous recommandons d'utiliser le shadowDocumentsMap paramètre à la place.

Note

Si vous spécifiez un shadowDocuments objet, vous ne devez pas le spécifier. shadowDocumentsMap

Chaque objet de cette liste contient les informations suivantes.

thingName

Nom de l'objet de l'appareil pour lequel les ombres doivent être synchronisées.

classic

(Facultatif) Si vous ne souhaitez pas synchroniser le shadow classique de l'thingNameappareil, réglez-le surfalse.

Par défaut : true

namedShadows

(Facultatif) La liste des ombres de périphériques nommées que vous souhaitez synchroniser. Vous devez indiquer le nom exact des ombres.

rateLimits

(Facultatif) Les paramètres qui déterminent les limites de débit pour les demandes de service parallèle.

Cet objet contient les informations suivantes.

maxOutboundSyncUpdatesPerSecond

(Facultatif) Nombre maximal de demandes de synchronisation par seconde transmises par l'appareil.

Par défaut : 100 requêtes/seconde

maxTotalLocalRequestsRate

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées au périphérique principal.

Par défaut : 200 requêtes/seconde

maxLocalRequestsPerSecondPerThing

(Facultatif) Le nombre maximum de demandes IPC locales par seconde envoyées pour chaque objet IoT connecté.

Par défaut : 20 requêtes/seconde pour chaque élément

Note

Ces paramètres de limites de débit définissent le nombre maximal de demandes par seconde pour le service parallèle local. Le nombre maximum de demandes par seconde pour le service AWS IoT Device Shadow dépend de votre Région AWS. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

shadowDocumentSizeLimitBytes

(Facultatif) Taille maximale autorisée de chaque document d'état JSON pour les ombres locales.

Si vous augmentez cette valeur, vous devez également augmenter la limite de ressources pour le document d'état JSON pour les ombres des nuages. Pour plus d'informations, consultez les limites de l'API AWS IoT Device Shadow Service dans le Référence générale d'Amazon Web Services.

Par défaut : 8192 octets

Maximum : 30720 octets

Exemple : mise à jour de la fusion de configurations

L'exemple suivant montre un exemple de mise à jour de fusion de configuration avec tous les paramètres de configuration disponibles pour le composant Shadow Manager.

{ "synchronize": { "coreThing": { "classic": true, "namedShadows": [ "MyCoreShadowA", "MyCoreShadowB" ] }, "shadowDocuments": [ { "thingName": "MyDevice1", "classic": false, "namedShadows": [ "MyShadowA", "MyShadowB" ] }, { "thingName": "MyDevice2", "classic": true, "namedShadows": [] } ] }, "rateLimits": { "maxOutboundSyncUpdatesPerSecond": 100, "maxTotalLocalRequestsRate": 200, "maxLocalRequestsPerSecondPerThing": 20 }, "shadowDocumentSizeLimitBytes": 8192 }

Fichier journal local

Ce composant utilise le même fichier journal que le composant Greengrass nucleus.

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
Pour consulter 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. Remplacez /greengrass/v2 C:\greengrass\v2 par le chemin d'accès au dossier AWS IoT Greengrass racine.

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

Journal des modifications

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

Version

Modifications

2.3.8

Corrections de bogues et améliorations
  • Résout un problème à cause duquel le Shadow Manager créait une situation de blocage lors de la connexion du client MQTT.

2.3.7

Corrections de bogues et améliorations
  • Résout un problème selon lequel le Shadow Manager enregistre régulièrement une NullPointerException erreur lors d'une synchronisation du Shadow Manager.

2.3.6

Corrections de bogues et améliorations
  • Résout un problème selon lequel les propriétés d'ombre supprimées par le biais de AWS Cloud mises à jour alors que l'appareil est hors ligne continuent d'exister dans l'ombre locale une fois la connectivité rétablie.

2.3.5

Version mise à jour pour la version 2.12.0 de Greengrass Nucleus.

2.3.4

Corrections de bogues et améliorations
  • Ajoute la prise en charge des documents à état fictif nuls et vides.

2.3.3

Version mise à jour pour la version 2.11.0 de Greengrass Nucleus.

2.3.2

Corrections de bogues et améliorations
  • Résout un problème selon lequel Shadow Manager passe à l'BROKENétat lorsque la base de données parallèle locale est corrompue.

  • Version mise à jour pour la version 2.10.0 de Greengrass Nucleus.

2.3.1

Corrections de bogues et améliorations
  • Résout un problème susceptible d'empêcher la synchronisation des mises à jour de Cloud Shadow.

  • Résout un problème selon lequel les modifications apportées à la configuration de synchronisation des ombres nommées ne s'appliquent qu'à une seule ombre nommée.

2.3.0

Corrections de bogues et améliorations
  • Résout un problème susceptible d'empêcher les ombres de se synchroniser lorsque la clé privée de l'appareil Greengrass est stockée dans un module de sécurité matériel.

2.2.4

Corrections de bogues et améliorations
  • Résout un problème en raison duquel la validation de la taille de l'ombre n'était pas cohérente avec celle du cloud lors de la mise à jour du document fantôme local.

  • Résout un problème selon lequel le gestionnaire fantôme arrête d'écouter les mises à jour de configuration si un déploiement effectue une RESET opération sur les nœuds de configuration.

2.2.3

Version mise à jour pour la version 2.9.0 de Greengrass Nucleus.

2.2.2

Version mise à jour pour la version 2.8.0 de Greengrass Nucleus.

2.2.1

Version mise à jour pour la version 2.7.0 de Greengrass Nucleus.

2.2.0

Nouvelles fonctionnalités
  • Ajoute la prise en charge du service parallèle local via l'interface de publication/d'abonnement locale. Vous pouvez désormais communiquer avec le courtier de messages local de publication/d'abonnement sur les sujets du shadow MQTT pour obtenir, mettre à jour et supprimer des ombres sur le périphérique principal. Cette fonctionnalité vous permet de connecter des appareils clients au service parallèle local en utilisant le pont MQTT pour relayer des messages sur des sujets cachés entre les appareils clients et l'interface de publication/d'abonnement locale.

    Cette fonctionnalité nécessite la version 2.6.0 ou ultérieure du composant Greengrass nucleus. Pour connecter les appareils clients au service parallèle local, vous devez également utiliser la version 2.2.0 ou ultérieure du composant pont MQTT.

  • Ajoute l'directionoption que vous pouvez configurer pour personnaliser la direction afin de synchroniser les ombres entre le service d'ombre local et le AWS Cloud. Vous pouvez configurer cette option pour réduire la bande passante et les connexions au AWS Cloud.

2.1.1

Corrections de bogues et améliorations
  • Résout un problème selon lequel la profondeur maximale des reported sections desired et du document d'état fantôme du périphérique JSON était de 4 niveaux au lieu de 5 niveaux.

  • Version mise à jour pour la version 2.6.0 de Greengrass Nucleus.

2.1.0

Nouvelles fonctionnalités
  • Prend en charge les intervalles périodiques de synchronisation parallèle, afin que vous puissiez configurer le périphérique principal afin de réduire l'utilisation de la bande passante et les frais.

2.0.6

Cette version contient des corrections de bogues et des améliorations.

2.0.5

Version mise à jour pour la version 2.5.0 de Greengrass Nucleus.

2.0.4

Corrections de bogues et améliorations
  • Résout un problème en raison duquel Shadow Manager supprimait les versions nouvellement créées de toutes les ombres précédemment supprimées.

  • Met à jour l'opération DeleteThingShadow IPC pour incrémenter la version fantôme lorsqu'elle est appelée.

2.0.3

Version mise à jour pour la version 2.4.0 de Greengrass Nucleus.

2.0.2

Corrections de bogues et améliorations
  • Correction d'un problème en raison duquel le gestionnaire des ombres ne reconnaissait pas la delta propriété lors de la synchronisation des états des ombres depuis AWS IoT Core.

  • Correction d'un problème qui provoquait parfois une fusion incorrecte des demandes de synchronisation pour une ombre.

2.0.1

Version mise à jour pour la version 2.3.0 de Greengrass Nucleus.

2.0.0

Première version.