fiware openlpwa iotagent DOWNLOAD - fiware openlpwa iotagent IOTAGENT Quellcode Download

fiware openlpwa iotagent

AI-Quellcode

2.0.2

Herunterladen

Fiware Lora®* IoT Agent

Dieses Projekt ist eine Brücke zwischen dem orangefarbenen Lora®* -Netzwerk und dem OMA NGSIV1 -Protokoll, das vom Orion Context Broker verwendet wird, sowie von anderen Komponenten des FIware -Ökosystems.

Überblick

Dieser IoT -Agent ist eine Bibliothek, die beispielsweise in einer Springboot -Anwendung verwendet werden kann.

Dieser Agent erlaubt:

Abrufen Sie Uplink -Payloads von Lora®* -Geräten ab, um einen NGSI -Kontextbroker zu aktualisieren.

Diese Bibliothek verwendet Live Objects®-Plattform (https://liveobjects

Die NGSI V1-Implementierung erfolgt in der orange-OpenSource/FIware-NGSI-API-Bibliothek.

Architektur

Hier ist die globale Architektur des IoT -Agenten, die Live Objects® -Plattform verwenden, um LORA®* -Geräte -Nutzlasten zu verwalten:

Architektur

Installation

Anforderungen

Java 8
Maven (für den Bau)
Ein Live -Objektkonto

Von Maven

Erstellen Sie ein Maven -Projekt mit Spring -Boot -Abhängigkeiten und unserer Bibliothek:

< dependency >
    < groupId >com.orange.fiware</ groupId >
    < artifactId >openlpwa-iotagent</ artifactId >
    < version >X.Y.Z</ version >
</ dependency >

wobei XYZ die Version der Bibliothek ist (prüfen Sie Git -Tags).

Konfiguration

Sie können einige Anwendungseinstellungen ändern, die entweder hinzufügen:

a src/main/resources/application.properties in Ihrer Anwendung.
Befehlszeilenparameter beim Start der Anwendung.

Dies ist eine Liste der Anwendungseigenschaften:

Name	Beschreibung	Standardwert
contextbroker.localurl	öffentliche URL zu dieser Instanz	http: // localhost: 8081
contextbroker.remoteurl	URL zum Remote -Broker (Orion)	http: // localhost: 8082
contextbroker.remotefiWareservice	Remote Broker Service Name
contextbroker.remotefiWareservicePath	Remote -Broker -Servicepfad
contextbroker.remoteAuthtoken	OAuth -Token für gesicherten Remote -Broker
contextbroker.remoteAuthtokenuri	URI zum Abrufen des Authentifizierungs -Tokens verwendet
contextbroker.remoteclientid	Remote -Kontext -Broker -Client -ID
contextbroker.remoteclientecret	Remote -Kontext -Broker -Client -Geheimnis
contextbroker.remoteuserLogin	Remote -Kontext -Broker -Benutzeranmeldung
contextbroker.remoteuserPassword	Remote -Kontext -Broker -Benutzerkennwort
OpenLPWAPROVIDER.Resturl	Live -Objekte® ** API -URL	https://lpwa.liveobjects.orange-business.com
OpenLPWAPROVIDER.APIKEY	Live -Objekte® ** API -Schlüssel
OpenLPWAPROVIDER.MQTTURI	Live -Objekte® ** Mqtt Broker URI	tcp: //liveObjects.orange-business.com: 1883
OpenLPWAPROVIDER.MQTTCLIENTID	Live Objects® ** MQTT Broker Client -Kennung	FIWARE-IITAGENT-KLIBE

Verwendung

Um ein LORA®* -Gerät mit dem Agenten zu verwenden, befolgen Sie die folgenden Schritte:

Registrieren Sie das Gerät auf der Live Objects® -Plattform.
Entschlüsseln und codieren Sie die Geräte -Nutzlasten.
Starten Sie den Agenten.

Registrieren Sie das Gerät auf der Live Objects® ** Plattform

Bevor Sie mit der Verwendung des Agenten beginnen, müssen Sie das Gerät im LPWA Live Objects®-Portal (https://lpwa.liveObjects.orange-business.com) registrieren. Wenn Ihr Gerät korrekt registriert und aktiv ist, sollten Sie bevorstehende Nutzlasten auf der Website sehen.

Erstellen und füttern Sie eine Warteschlange (FIFO) auf der Live Objects® ** -Plattform

Daten, die von Live -Objekten gesammelt wurden, können in Nachrichtenwarteschlangen (FIFO) weitergeleitet werden. Die Schaffung einer Routing -Regel erfolgt in drei Schritten:

Name der Regel
Auswahlkriterien für die Routed von Nachrichten
Routing -Modus (FIFO)

Sie können Ihr FIFO erstellen und Ihre Routing-Regeln für Live Objects®-Portal (https://lpwa.liveobjects.orange-business.com) definieren.

Entschlüsseln und codieren Sie die Geräte -Nutzlasten

Live Objects® -Plattform verwaltet LORA®* Hexadezimal -Nutzlasten. Es ist nicht möglich, die Nutzlast auf der Plattform zu dekodieren. Sie müssen diesen Vorgang durchführen, wenn Sie den Agenten verwenden.

Um diesen Job zu erledigen, müssen Sie OpenLpwaNgsiConverter -Schnittstelle mit den beiden folgenden Methoden implementieren:

 public class MyOpenLpwaNgsiConverter implements OpenLpwaNgsiConverter {
@ Override
    public List < ContextAttribute > decodeData ( String deviceID , String data ) {
      // Decode the hexadecimal payload to build a list of NGSI context attributes
    }

Die Methode decodeData ist für jede von einem Gerät gesendete Uplink -Nutzlast aufgerufen. Sie müssen diese Methode implementieren, um eine gesendete hexadezimale Nutzlast zu dekodieren und eine Liste von NGSI -Kontextattributen zu erstellen, um die mit dem Gerät zugeordnete NGSI -Entität zu aktualisieren (siehe Start The Agent).

 @ Override
    public String encodeDataForCommand ( String deviceID , String commandName , ContextAttribute attribute ) {
        String data = attribute . getValue (). toString ();
        // Build an hexadecimal payload to send a command
    }

Die Methode encodeDataForCommand ist für jede Downlink -Nutzlast aufgerufen, um an ein Gerät zu senden (siehe Befehl senden an ein Gerät). Sie müssen diese Methode implementieren, um den Befehl in einem NGSI -Kontextattribut abzurufen und die entsprechende hexadezimale Nutzlast zu codieren, um sie an ein Gerät zu senden.

Authentifizierung mit Remote Context Broker

Nicht authentifizierter Modus

Ohne ein Token oder Anmeldeinformationen sendet der Agent Nachrichten, ohne zu versuchen, sich an den Remote -Kontext -Broker zu authentifizieren.

Token -Authentifizierungsmodus

Wenn ein Token ausgefüllt ist, wird der Agent dieses Token verwenden, um sich mit dem Remote -Kontextbroker zu authentifizieren, bevor er eine Nachricht sendet. Wenn das Token ungültig ist, versucht der Agent, die angegebenen Anmeldeinformationen zu verwenden, um eine neue zu generieren.

Anmeldeinformationen Authentifizierungsmodus

Wenn die Anmeldeinformationen ausgefüllt sind, verwendet der Agent sie, um ein Token aus dem gegebenen URI zu generieren. Solange dieses Token gültig ist, wird der Agent es weiterhin verwenden. Wenn das Token nicht mehr gültig ist, versucht der Agent, es durch eine neue zu ersetzen, basierend auf den angegebenen Anmeldeinformationen.

Starten Sie den Agenten

Die Bibliothek bietet eine Agent , um den Agenten zu verwalten. Sie sollten einfach die start aufrufen, um 3 Parameter zu übergeben:

Der erste Parameter ist eine Instanz Ihres benutzerdefinierten Konverters.
Der zweite Parameter ist ein AgentSuccessCallback der aufgerufen wird, wenn der Agent korrekt gestartet wird.
Der dritte Parameter ist ein AgentFailureCallback der aufgerufen wird, wenn der Agent nicht korrekt gestartet wird.

Hier ist ein Beispiel, um den Agenten zu starten:

 @ SpringBootApplication
@ ComponentScan ( "com.orange" )
public class Application implements ApplicationListener < ApplicationReadyEvent > {
    private static Logger logger = LoggerFactory . getLogger ( Application . class );
    @ Autowired
    private Agent agent ;

    public static void main ( String [] args ) {
        new SpringApplicationBuilder ()
                . sources ( Application . class )
                . bannerMode ( Banner . Mode . LOG )
                . run ( args );
    }

    @ Override
    public void onApplicationEvent ( ApplicationReadyEvent applicationReadyEvent ) {
        agent . start ( new MyOpenLpwaNgsiConverter (),
                () -> {
                    logger . debug ( "IoT agent started" );
                },
                ex -> {
                    logger . error ( "IoT agent not started" , ex );
                }
        );
    }
}