OSF Writer

Description

Le module « osfwriter » consomme des données de canal et écrit ces données dans des fichiers au format OSF Streaming Format V4.

Interfaces et protocoles utilisés

• Format de fichier OSF 4

Configuration JSON

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

Exemple de configuration (minimale)

Voici un exemple de configuration de l'OSF Writer :

    {
      "module":"OSFWriter",
      "factory":"osfwriter",
      "config":{
      }
    }

Exemple de configuration (maximale)

Voici un exemple de configuration de l'OSF Writer :

    {
      "module":"OSFWriter",
      "factory":"osfwriter",
      "config":{
        "filename":"/sde/<tag>/<date>/<date>_<time>.osf",
        "tag":"preview",
        "pollingInterval":1000,
        "samplesPerConsume":1024,
        "newfile":"time",
        "time":900000,
        "volume":10000000,
        "channels":[
          "mvb*",
          "can*",
          "gps*"
        ],
        "ignore":[
          "Some.Ignored.Namespace*",
          "someIgnoredChannel"
        ],
        "refreshIntervalMs":60000
      }
    }

Paramètres globaux du module

Nom du paramètre	Obligatoire	Type de données	Plage de valeurs utile	Défaut	Description
filename	Non	STRING	voir ci-dessous	"/sde/"TAG"/"DATE"/"DATE"_"TIME".osf"	Nom de fichier ou structure du nom de fichier (voir ci-dessous)
tag	Non	STRING		"preview"	Désignation du tag
pollingInterval	Non	INT	1 -	1000	Intervalle d'interrogation (polling) [ms]
samplesPerConsume	Non	INT	1 -	1024	nombre max. d'échantillons (samples) consommés par intervalle d'interrogation
newfile	Non	STRING	"time", "volume"	"time"	Raison du fractionnement de l'enregistrement en plusieurs fichiers
time	Non	INT	1 -	900000 (15 min)	intervalle de temps maximal approximatif [ms] avant la création d'un nouveau fichier OSF
volume	Non	INT	1 -	10 MB	taille approximative du fichier [octets] avant la création d'un nouveau fichier OSF
maximumAncientRangeMs	Non	INT	0 -	15000 (15 s)	plage maximale admissible avant le début du fichier dans laquelle se trouvent des échantillons fiables. Si ces échantillons sont antérieurs, ils sont décalés au début de cette plage. Si la valeur est -1, AUCUN décalage
channels	Non	JSON Array		[ "*" ]	Tableau JSON avec les noms de canaux sous forme de chaîne
ignore	Non	JSON Array		[ ]	Tableau JSON avec les noms de canaux ignorés sous forme de chaîne
refreshIntervalMs	Non	INT	1 -	60000 (60 s)	Nouvelle écriture de valeurs identiques à l'expiration d'un intervalle, si l'horodatage fiable associé a été mis à jour

Pour les noms de canaux spécifiés, des caractères de substitution, c'est-à-dire '?' (remplace un seul caractère), ou des jokers (wildcards), c'est-à-dire '*' (remplace une chaîne de caractères de longueur quelconque), peuvent être utilisés.

Spécification du nom de fichier 'filename'

Le nom de fichier est spécifié au moyen d'un chemin, p. ex.

/sde/<tag>/<date>/<date>_<time>.osf

Les variables possibles sont :

• <year> (p. ex. 2022)
• <month> (p. ex. 01)
• <day> (p. ex. 01)
• <hour> (p. ex. 01, 23)
• <minute> (p. ex. 01)
• <second> (p. ex. 01)
• <msecond> (p. ex. 001)
• <date> := "<year><month><day>"
• <time> := "<hour><minute><second>"
• <tag> (voir le paramètre 'tag')

Informations sur le module

Information	Valeur
Auteurs	optiMEAS GmbH
depuis smartCORE	0
Type de module	Fast Message Receiver, Producer
Dépendances	module émetteur de Fast Message (p. ex. fmudp, canbus, smartmvb, ...)