IoT Simulator API Dokumentation

Einleitung

IoT Simulator API hilft Ihnen, mitBevywise IoT SimulatorNetzwerk und Clients zu erstellen und zu entfernen, Events zu erstellen und Publish for the add Clients, to Create and Remove Subscription zu den hinzugefügten Clients, zu erstellen und entfernen Antwort für die hinzugefügt Kunden.

Diese API wird mit Hilfe vonREST Frameworkdie über HTTP arbeitet. Sie können das IoT integrieren Simulator mit Ihrem Testautomatisierungs-Framework mit diesen APIs für eine vollständige Regressionsprüfung.

Neues Gerät hinzufügen

Diese Methode wird ein neues MQTT Device zu einem bereits laufenden hinzufügen simulator. Die Clean-Session, wird Meldung , wird QoS, als Teil dieses Verfahrens kann ein Halter etc. angegeben werden.

Diese API wird mit dem REST Framework implementiert, das funktioniert über HTTP. Sie können den IoT-Simulator mit Ihr Testautomatisierungs-Framework mit diesen APIs für eine komplette Regressionstest.

Methode:

Post

http://localhost:9000/api/addclient

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie Gerät erstellen möchten
Gerät_id Wird verwendet, um das Gerät zu identifizieren
Beschreibung Details zum Gerät
clean_session Saubere Sitzung einstellen
werden. Die Will-Flagge aktivieren
Willtop Thema für die Willensnachricht
wird nachrichten Nachricht wird veröffentlicht
in den Warenkorb QoS-Ebene für Will Messaage
wird entzogen haben Flagge aktivieren
Benutzername Authentication Credentials
Passwort vergessen? Authentication Credentials

Antwort:

{\cHFFFF}
„Device“:device_id,
"Status":Gerät wird in die Datenbank aufgenommen und mit Broker verbunden '
}

Entfernen Sie das angeschlossene Gerät

Diese IoT-Simulator-API-Methode hilft Ihnen, die MQTT zu entfernen Gerät, das mit dem Simulator verbunden war

Methode

Los!

http://localhost:9000/api/get/removeclient

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie das Gerät entfernen möchten
Gerät_id Id des angeschlossenen Gerätes

Antwort:

{\cHFFFF}
"Status":Client wird entfernt '
}

IoT Simuator API – Gerät starten

Diese Methode wird die Täuschung beginnen, indem sie mit dem Broker verbinden.

Methode

Los!

http://localhost:9000/api/get/startdevice

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie das Gerät starten möchten
Gerät_id Id des Geräts, das Sie starten möchten

Antwort:

{\cHFFFF}
„Nettowork“: „network_chosen“, ''Device':'device_id', ''status':'Device is Gestartet

Stop Device

Diese IoT-Simulator-API-Methode wird das Gerät von den Broker zu trennen.

Methode

Los!

http://localhost:9000/api/get/stopdevice

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie das Gerät entfernen möchten
Gerät_id Id des angeschlossenen Gerätes

Antwort:

{\cHFFFF}
„Nettowork“: „network_chosen“,
„Device“:device_id,
"Status": "Gerät wird gestoppt '
}

Geräteliste herunterladen

Diese Methode wird die Liste der Geräte in einem Netzwerk anzeigen.

Methode

Los!

http://localhost:9000/api/get/deviceslist

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie das Gerät anzeigen möchten Liste

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
„Geräteliste“: [{"ID":device_id',"Name":device_name',"Description":Description}',
'{"ID":device_id,"Name":device_name',"Description":Description},..] '
}

Informationen zum Gerät

Dieses Verfahren zeigt die Einzelheiten eines bestimmten Geräts in einem Netzwerk .

Methode

Los!

http://localhost:9000/api/get/devicedetails

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie das Netzwerk, in dem Sie das Detail eines besondere Vorrichtung
Gerät_id ID des Geräts, für das wir das Detail ansehen möchten

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Entfernung": "device_id"
"Will_Details":{}',
"Auth_details":[{ 'auth key':username, 'auth_token': Passwort}]',
"Abonnement": [ { } ], "Behavior": [ { } ], "Ereignisse": '
}

Start Netzwerk

Dieses Verfahren wird das gesamte Gerät starten, indem es mit dem Broker

Methode

Los!

http://localhost:9000/api/get/startalldevices

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk zum Starten

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Started":Anzahl des Gerätes gestartet',
'"Failed": Anzahl der Geräte nicht gestartet '
}

IoT Simulator API – Netzwerk stoppen

Diese Methode wird alle Geräte stoppen, indem sie es von der Broker.

Methode

Los!

http://localhost:9000/api/get/stopalldevices

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk zum Stoppen

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
'"Stopped_count": Anzahl der Geräte getrennt '
}

Netzwerkliste hinzufügen

Diese Methode wird alle im Simulator erstellten Netzwerke auflisten

Methode

Los!

http://localhost:9000/api/get/networklist

Antwort:

{\cHFFFF}
„network_list“:[ { } ] '
}

Netzwerkstatus erhalten

Diese Methode zeigt den Status des gegebenen Netzwerks

Methode

Los!

http://localhost:9000/api/get/networkstatus

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um den Status zu kennen

Antwort:

{ 'network_name':network_chosen',
"Running":Anzahl des angeschlossenen Geräts",
"Not_Running":Anzahl des Gerätes nicht angeschlossen '
}

Wählen Sie ein Netzwerk

Diese IoT Simulator API Methode wird verwendet, um ein Netzwerk für API zu wählen Integration.

Methode

Los!

http://localhost:9000/api/get/setnetwork

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie einen Netzwerknamen

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Status":Netzwerk wurde ausgesucht '
}

Veranstaltung stoppen

Diese Methode wird verwendet, um alle Veröffentlichungsveranstaltungen zu stoppen.

Methode

Los!

http://localhost:9000/api/get/stopevent

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um die Ereignisse zu stoppen
Veranstaltungskalender ID der konfigurierten Evnets

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
„Event_ID“:event_id“
„Status“: Die Veranstaltung ist beendet '
}

Wiederaufnahme

Diese Methode wird verwendet, um die gestoppten Ereignisse wieder aufzunehmen.

Methode

Los!

http://localhost:9000/api/get/resumeevent

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um die Ereignisse wieder aufzunehmen
Veranstaltungskalender ID der konfigurierten Events

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
„Event_ID“:event_id“
„Status“: Veranstaltung wird fortgesetzt '
}

IoT Simulator API – Publish

Mit diesem Verfahren werden Ereignisse für ein bestimmtes Gerät in einem Netzwerk.

Methode

Post

http://localhost:9000/api/publishclient

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um die veröffentlichten Ereignisse zu sehen besondere Vorrichtung
Gerät_id ID des Veröffentlichungsgeräts
Thema Thema der Veröffentlichungsveranstaltungen
Nachricht Nachricht wird veröffentlicht
Q QoS-Ebene
zurück Flagge für das Publish Device behalten

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Topic":topic",
„Status“: Veröffentlicht,
"Message":message",
„veröffentlicht bei“:time_of_publish',
}

Veröffentlichungen

Diese Methode wird verwendet, um beschädigte Ereignisse für eine bestimmte Gerät in einem Netzwerk.

Methode

Post

http://localhost:9000/api/publishclient_with_corruption

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um die beschädigte veröffentlichen Veranstaltung anzuzeigen
Gerät_id ID des Veröffentlichungsgeräts
Thema Thema der Veröffentlichung
Nachricht Nachricht wird veröffentlicht
Q QoS-Ebene
zurück Flagge für das Publish Device behalten

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Topic":topic",
„Status“: Veröffentlicht,
"Message":message",
„veröffentlicht bei“:time_of_publish',
}

Entfernen Sie den Publish Nachricht

Mit diesem Verfahren wird das Ereignisthema von einem bestimmten entfernt Gerät in einem Netzwerk

Methode

Post

http://localhost:9000/api/removepublish

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um das Event-Thema aus einem Spezielle Vorrichtung
Gerät_id ID des Geräts, für das das Ereignisthema entfernt werden will
Thema Thema der zu entfernenden Ereignisse

Antwort:

{\cHFFFF}
„Gerät“: „device_id“;
"Status":Event Topic wird aus der Datenbank entfernt '
}

Antwort auf Anfrage hinzufügen

Mit diesem Verfahren wird ein neues Verhaltensmuster für eine bestimmte Gerät in einem Netzwerk

Methode

Post

http://localhost:9000/api/addresponse

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um ein neues Verhaltensmuster für ein Spezielle Vorrichtung
Gerät_id ID des Geräts, für das Antwort erzeugt wird
Veranstaltung_top Erstelltes Eventthema
Event_Daten Veröffentlichte Ereignisdaten
Befehlshaber_Daten Wiederholen von Daten
Q RQoS Level
zurück Flagge

Antwort:

{\cHFFFF}
„Gerät“: „device_id“;
"Status":Request Response Nachricht wird hinzugefügt erfolgreich '
}

Antwort auf Anfrage entfernen

Mit diesem Verfahren wird ein Verhaltensmuster von einem bestimmten entfernt Gerät in einem Netzwerk

Methode

Post

http://localhost:9000/api/removeresponse

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um ein Verhaltensmuster von einem Spezielle Vorrichtung
Gerät_id ID des Geräts, für das Antwortthema sein will entfernt
Thema Veranstaltungsthema, für das Sie Antwort entfernen möchten

Antwort:

{\cHFFFF}
„Gerät“: „device_id“; "Status":Behavior Pattern wird aus der Datenbank entfernt ' }

Behavior Simulation stoppen

Diese Methode wird verwendet, um das Verhaltensmuster / Antwort von einer insbesondere Gerät in einem Netzwerk

Methode

Post

http://localhost:9000/api/stopres

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um ein Verhaltensmuster von einem Spezielle Vorrichtung
Gerät_id ID des Geräts, für das Antwort gestoppt werden will
Thema Veranstaltungsthema, für das Sie die Antwort stoppen möchten

Antwort:

{\cHFFFF}
„Gerät“: „device_id“;
"Status":Behavior Simulation wird gestoppt '
}

Anmeldung

Mit diesem Verfahren wird ein Befehl für ein bestimmtes Gerät abonniert in einem Netzwerk

Methode

Post

http://localhost:9000/api/subscribeclient

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um einen Befehl für eine bestimmte zu abonnieren Gerät
Gerät_id ID des Geräts, in dem das abonnierte Thema hinzugefügt wird
Thema Thema, das abgemeldet werden soll
Q QoS Ebene
Addtod B. Beschriebenes Thema zur Datenbank hinzugefügt

Antwort:

{\cHFFFF}
''device':'device_id', 'Status':Topic wird abonniert

Abonnieren Details

Diese Methode wird verwendet, um die Abonnementdetails einer insbesondere Vorrichtung in einem Netzwerk

Methode

Los!

http://localhost:9000/api/get/subscribedetails

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um die Abonnementdetails eines Spezielle Vorrichtung
Gerät_id ID des Geräts, von dem die Abonnementdetails sind abgerufen

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Device": "device_id"
'Topics': ['topic1','topic2']

Neu anmelden

Diese Methode wird verwendet, um ein neues Abonnement Thema für ein insbesondere Vorrichtung in einem Netzwerk

Methode

Post

http://localhost:9000/api/addsubscribe

Antwort:

{\cHFFFF}
„network_name“:network_chosen,
"Device": "device_id"
"Abonnement_details": "Abonnieren": wann_to_subscribe, "Command_Topic": Thema, "QoS": QoS, "Command_ID":
}

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um einen neuen Befehl für eine bestimmte Gerät
Gerät_id ID des Geräts, in dem das abonnierte Thema zu sein ist hinzugefügt
Thema Thema, das neu abonniert wird
Q QoS Ebene

Antwort:

{\cHFFFF}
„Gerät“: „device_id“;
'"Status":Command Topic wird in der Datenbank hinzugefügt erfolgreich '
}

Abonnieren

Mit diesem Verfahren wird ein Befehl von einem bestimmten Gerät entfernt in einem Netzwerk.

Methode

Post

http://localhost:9000/api/removesubscribe

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um einen Befehl von einem bestimmten zu entfernen Gerät
Gerät_id ID des Geräts, in dem das Abonnement sein soll entfernt
Thema Abonnieren Thema

Antwort:

{\cHFFFF}
„Gerät“: „device_id“;
"Status":Command Topic wird aus der Datenbank entfernt '
}

Alle anzeigen

Diese Methode dient dazu, alle Befehle in einem Netzwerk abzumelden

Methode

Post

http://localhost:9000/api/unsubscribeall

Parameter:

PARAMETER VALUE DETAIL
Netzwerk_chosen Wählen Sie ein Netzwerk, um alle Befehle abzumelden
Gerät_id ID des Geräts, in dem das Abonnement sein soll entfernt
Thema Abonnieren Thema

Antwort:

{\cHFFFF}
„Status“: Alle Themen des angeschlossenen Gerätes sind abgemeldet '
}

Suche nach Bevywise
IoT Simulator?

Entdecken Sie unsere FAQ Seite