Module récepteur UDP « fmudp »

Description

Le module 'fmudp' met à disposition un socket UDP. Il est généralement utilisé avec le module fmproducer, qui extrait de manière appropriée les données « brutes » des paquets UDP et les produit dans des canaux. (En principe, il est toutefois aussi possible d'utiliser, par exemple, un module récepteur « dbc », c'est-à-dire de spécifier les canaux sous forme de fichier DBC CAN bus, ...)

Interfaces et protocoles utilisés

• Communication réseau UDP

Configuration JSON

La section suivante décrit l'ensemble de la configuration JSON du module et explique chacun des paramètres.

Exemple de configuration (configuration pour un seul format de paquet UDP)

Si un seul format de paquet UDP doit être reçu, il suffit de définir l'enregistrement des fonctions ou modules Fast Message Receiver indépendamment de toute identification. Cela se fait en général de manière différente pour chaque module Fast Message Receiver. Si toutefois, comme dans l'exemple, un module fmproducer est utilisé, cette définition peut être effectuée au moyen du paramètre "messageKey": 0).

    {
      "module":"UDP",
      "factory":"fmudp",
      "config":{
        "port":12345
      }
    },
    {
      "module":"Producer",
      "factory":"fmproducer",
      "config":{
        "fmd":"UDP",
        "channelPrefix":"UDP",
        "channels":[
          {
            "name":"Some Channel Name",
            "dataType":"int8",
            "scale":1,
            "offset":0,
            "physicalUnit":"",
            "messageKey":0,
            "bitOffset":0,
            "bitLength":8,
            "imageType":"signed"
          },

          [...]

        ]
    },

Exemple de configuration (configuration pour plusieurs formats de paquets UDP différents)

Si en revanche des paquets UDP de formats différents doivent être reçus, ceux-ci doivent contenir une zone commune destinée à la transmission d'une clé d'identification (key). Cette zone doit être configurée dans le module fmudp. En outre, toutes les fonctions/modules récepteurs (éventuellement par canal) doivent être configurés avec les valeurs correspondantes de la clé d'identification (définies dans l'exemple suivant sous messageKey pour chacun).

    {
      "module":"UDP",
      "factory":"fmudp",
      "config":{
        "port":12345,
        "keyBitOffset":0,
        "keyBitLength":32,
        "keyByteOrder":"bigendian"
      }
    },
    {
      "module":"Producer",
      "factory":"fmproducer",
      "config":{
        "fmd":"UDP",
        "channelPrefix":"UDP",
        "channels":[
          {
            "name":"Some Channel from Message Format 1 (42) Name",
            "dataType":"int8",
            "scale":1,
            "offset":0,
            "physicalUnit":"",
            "messageKey":42,
            "bitOffset":32,
            "bitLength":8,
            "imageType":"signed"
          },
          {
            "name":"Some Channel from Message Format 2 (43) Name",
            "dataType":"double",
            "scale":1,
            "offset":0,
            "physicalUnit":"",
            "messageKey":43,
            "bitOffset":32,
            "bitLength":64,
            "imageType":"float"
          },

          [...]

        ]
    },

Paramètres globaux du module

Nom du paramètre	Requis	Type de données	Plage de valeurs pertinente	Valeur par défaut	Description
fmd	Non	STRING		Nom de l'instance du module (spécifié dans la section de configuration sous module)	Nom du Fast Message Dispatcher mis à disposition pour le raccordement d'un Fast Message Receiver (par exemple un module fmproducer)
priority	Non	INT	20 - 80	80	Priorité du thread de la boucle d'interrogation
port	OUI	INT16	0 - 65535		Port UDP pour la réception des paquets
keyBitOffset	Non	INT	dans la longueur du paquet UDP	0	Décalage de la clé d'identification si des paquets UDP différents doivent être interprétés différemment
keyBitLength	Non	INT	tel que keyBitOffset + keyBitLength reste dans le paquet UDP	0	Longueur de la clé d'identification si des paquets UDP différents doivent être interprétés différemment
keyByteOrder	Non	STRING	"bigendian", "littleendian"	"bigendian"	Ordre des octets de la clé d'identification

Informations sur le module

Information	Valeur
Auteurs	optiMEAS GmbH
depuis smartCORE	0.103
Type de module	Producer (Dispatcher)
Dépendances	Fast Message Receiver