Description

L’API SHIPHarbour redéfinit tous les types de données primitifs du format protobuf en messages afin de pouvoir tester si le membre a été initialisé ou non. En effet, il n’existe aucun moyen de savoir si un membre a été défini intentionnellement sur la valeur par défaut ou s’il n’a jamais été défini, à moins que le membre ne soit un message. De plus, toutes les énumérations sont déclarées dans ce fichier, car il n’est pas possible d’avoir deux types d’énumération différents pour utiliser le même nom.

Primitives

SInt64Value

Valeur entière signée 64 bits encodée de longueur variable.

UInt64Value

Valeur entière 64 bits non signée encodée de longueur variable.

Fixed64Value

Valeur entière 64 bits non signée encodée de longueur fixe.

DoubleValue

Valeur à virgule flottante 64 bits encodée de longueur fixe.

Int32Value

Valeur entière signée de 32 bits encodée en longueur variable.

UInt32Value

Valeur entière 32 bits non signée encodée de longueur variable.

FloatValue
Valeur à virgule flottante 32 bits de longueur fixe.

BoolValue
Valeur binaire de longueur fixe.

Valeurs
de texte UTF-8 et/ou ASCII 7 bits de longueur arbitraire.

BytesValue
Valeurs d’octets de longueur arbitraire.

Enums

VersionCode
Apparaît dans toutes les requêtes SHIPHarbour, utilisé pour suivre les modifications qui brisent la compatibilité des structures de messages SHIPHarbour.

ErrorCode
Apparaît dans toutes les requêtes SHIPHarbour, utilisé pour valider si une opération demandée a fonctionné et diagnostiquer les échecs.

ProgramType
Utilisé dans le cadre du type de programme pour décrire un type de programme qui peut s’exécuter sur un module SERIOUS.

ProgramState
Utilisé dans le cadre du type de programme pour décrire l’état d’un programme qui peut s’exécuter sur un module SERIOUS.

FirmwareType
Utilisé par ModuleInfo demande de signaler le type de programme en cours d’exécution d’un module SERIOUS. Également utilisé par les demandes de micrologiciel.

UpdateMethod
Utilisé par les demandes de mise à jour pour spécifier comment le module est autorisé à appliquer la mise à jour.

UpdateStage
Utilisé en réponse aux demandes de mise à jour pour notifier l’étape du processus de mise à jour en cours.

FSType
Used by Files demande la spécification d’un système de fichiers cible sur un module SERIOUS.

Types de noyaux

Program

Utilisé par les requêtes SetState pour décrire le programme et la transition d’état souhaités, ainsi que le programme et l’état actuels.

FirmwareVersion
Utilisé dans le cadre du type Firmware pour décrire la version d’un firmware.

Firmware

Utilisé dans le cadre du type ModuleDetails pour informer le client du programme en cours d’exécution du module Serious.

Endpoint

Utilisé pour identifier de manière unique un canal de communication entre un module Serious et SHIPHarbour Master.

Module

Utilisé dans le cadre du type ModuleDetails pour identifier de manière unique le module Serious et les points de terminaison associés.

ModulesDétails
Utilisé dans les mises à jour spontanées de ModuleInfo pour informer le client des connexions et des déconnexions de modules dans SHIPHarbour Master.

PluginDetails
Utilisé dans les mises à jour spontanées de PluginInfo pour informer le client sur les plugins de communication disponibles dans SHIPHarbour Master.

RoutineInfo
Apparaît dans toutes les demandes de routine, utilisé pour créer et acheminer une demande d’exécution d’une opération sur un point de terminaison spécifique à l’intérieur de SHIPHarbour Master.