IoT Simulator API Documentation

Introducción

IoT Simulator API le ayuda a comunicarse conBevywise IoT Simulatorcrear y eliminar redes y clientes, crear eventos y Publicar para los clientes añadidos, crear y eliminar suscripción a los clientes añadidos, para Crear y Eliminar Respuesta para el Clientes.

Esta API se implementa utilizandoREST Frameworkque opera sobre HTTP. Usted será capaz de integrar el IoT Simulador con su marco de automatización de pruebas utilizando estas API para una prueba completa de regresión.

Añadir un nuevo dispositivo

Este método añadirá un nuevo dispositivo MQTT a un ya en funcionamiento simulador. La sesión limpia , mensaje , QoS , será retener etc se puede especificar como parte de este método.

Esta API se implementa utilizando el Marco REST que opera sobre HTTP. Usted será capaz de integrar el Simulador IoT con su marco de automatización de pruebas utilizando estas API para un completo pruebas de regresión.

Método:

Puesto

http://localhost:9000/api/addclient

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la Red en la que desea crear dispositivo
device_id Se utiliza para identificar el dispositivo
descripción Detalles sobre el dispositivo
clean_session Para establecer una sesión limpia
will_flag Para habilitar la bandera de la voluntad
willtopic Tema para el mensaje de voluntad
willmessage Mensaje para ser publicado
willqos Nivel QoS para Will Messaage
willretain Activar la bandera
nombre de usuario Credenciales de autenticación
contraseña Credenciales de autenticación

Respuesta:

{}
"Dispositivo":device_id",
"Status":El dispositivo se añade a la base de datos y conectado con el corredor '
}

Eliminar el dispositivo conectado

Este método IoT Simulator API le ayudará a eliminar el MQTT Dispositivo conectado al simulador

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la red en la que desea eliminar el dispositivo
device_id Id del dispositivo conectado

Respuesta:

{}
''Status':Client se retira '
}

IoT Simuator API – Start Device

Este método iniciará el deivce conectandolo al Broker.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la Red en la que desea iniciar el dispositivo
device_id Id del dispositivo que quieres empezar

Respuesta:

{}
"network": 'network_chosen', "Dispositivo": 'device_id', 'status':'El dispositivo es Comenzó.

Detener el dispositivo

Este método IoT Simulator API detendrá el dispositivo por desconectarlo del Broker.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la red en la que desea eliminar el dispositivo
device_id Id del dispositivo conectado

Respuesta:

{}
"network": 'network_chosen',
"Dispositivo":device_id",
"status": "El dispositivo se detiene '
}

Obtener lista de dispositivos

Este método mostrará la lista de dispositivos en una red.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la Red en la que desea ver el dispositivo lista

Respuesta:

{}
"network_name":network_chosen,
"lista de dispositivos": [{"ID":device_id',"Name":device_name',"Description":Description}',
'{"ID":device_id,"Name":device_name",Description":Description},.] '
}

Obtener detalles del dispositivo

Este método mostrará los detalles de un dispositivo en particular en un red.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija la Red en la que desea ver el detalle de un dispositivo particular
device_id ID del dispositivo para el cual queremos ver el detalle

Respuesta:

{}
"network_name":network_chosen,
"dispositivo": 'device_id',
"Detalles"
"Auth_details": [{ 'auth key':username, 'auth_token': password}],
Suscripción: "Eventos": '
}

Start Network

Este método iniciará todo el dispositivo conectándolo al Broker

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para empezar

Respuesta:

{}
"network_name":network_chosen,
"Iniciado": la mayoría del dispositivo comenzó,
'"Failed": número de dispositivo no comenzó '
}

IoT Simulator API – Stop Network

Este método detendrá todos los dispositivos desconectándolo del Broker.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para detener

Respuesta:

{}
"network_name":network_chosen,
"Stopped_count": número de dispositivo desconectado '
}

Lista de redes

Este método enumerará todas las redes creadas en el Simulador

Método

Vamos.

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

Respuesta:

{}
"network_list": '
}

Get Network Status

Este método mostrará el estado de la red dada

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para conocer el estado

Respuesta:

"network_name":network_chosen,
"Running": número de dispositivo conectado,
"Not_Running": número de dispositivo no conectado '
}

Elija una red

Este método IoT Simulator API se utiliza para elegir una red para API integración.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija un nombre de red

Respuesta:

{}
"network_name":network_chosen,
"Status":La red era Choosen '
}

Para el evento

Este método se utiliza para detener todos los eventos de publicación.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para detener los eventos
event_id ID of the Configured Evnets

Respuesta:

{}
"network_name":network_chosen,
"Event_ID":event_id",
"Status": El evento se detiene '
}

Resumen del evento

Este método se utiliza para reanudar los eventos parados.

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para reanudar los eventos
event_id ID of the Configured Events

Respuesta:

{}
"network_name":network_chosen,
"Event_ID":event_id",
"Status": El evento es reanudar '
}

IoT Simulator API – Publish

Este método se utiliza para publicar eventos para un dispositivo en particular en un red.

Método

Puesto

http://localhost:9000/api/publishclient

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Escoge una Red para ver los eventos publicados dispositivo particular
device_id ID of the Publishing Device
Tema Tema de los eventos publicados
Mensaje Mensaje para ser publicado
qos Nivel QoS
retenimiento Retener la bandera para el dispositivo Publish

Respuesta:

{}
"network_name":network_chosen,
"Tema":tópico",
"Status":Published,
"Message":mensage",
"Published at":time_of_publish"
}

Publish_with_Error

Este método se utiliza para publicar evento corrupto para un particular dispositivo en una red.

Método

Puesto

http://localhost:9000/api/publishclient_with_corrupción

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para ver el evento publicado corrupto
device_id ID of the Publishing Device
Tema Tema del evento publicado
Mensaje Mensaje para ser publicado
qos Nivel QoS
retenimiento Retener la bandera para el dispositivo Publish

Respuesta:

{}
"network_name":network_chosen,
"Tema":tópico",
"Status":Published,
"Message":mensage",
"Published at":time_of_publish"
}

Remove Publish Mensaje

Este método se utiliza para eliminar el tema del evento de un particular Dispositivo en una red

Método

Puesto

http://localhost:9000/api/removepublish

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para eliminar el tema del evento de un particular Dispositivo
device_id ID del dispositivo para el cual el tema del evento quiere ser eliminado
Tema Tema de los eventos para ser eliminado

Respuesta:

{}
"Dispositivo": 'device_id',
"Status":Event Topic se retira de la base de datos '
}

Add Response for Request

Este método se utiliza para añadir un nuevo patrón de comportamiento para un determinado Dispositivo en una red

Método

Puesto

http://localhost:9000/api/addresponse

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para añadir un nuevo patrón de comportamiento para un particular Dispositivo
device_id ID del dispositivo para el cual se crea la respuesta
event_topic Tema creado del evento
event_data Datos publicados del evento
command_data Datos de respuesta
qos Nivel de RQoS
retenimiento bandera

Respuesta:

{}
"Dispositivo": 'device_id',
'Status':Request Response Message is added con éxito '
}

Eliminar la respuesta para la solicitud

Este método se utiliza para eliminar un patrón de comportamiento de un determinado Dispositivo en una red

Método

Puesto

http://localhost:9000/api/removeresponse

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para eliminar un patrón de comportamiento de un particular Dispositivo
device_id ID del dispositivo para el cual el tema de respuesta quiere ser Retirada
Tema Tema del evento para el cual desea eliminar la respuesta

Respuesta:

{}
"Dispositivo": 'device_id', "Status":El patrón de comportamiento se retira de la base de datos ' }

Parar la simulación del comportamiento

Este método se utiliza para detener el patrón de comportamiento / respuesta de un particular Dispositivo en una red

Método

Puesto

http://localhost:9000/api/stopres

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para Parar un patrón de comportamiento de un particular Dispositivo
device_id ID del dispositivo para el cual la respuesta quiere ser detenida
Tema Tema del evento para el cual desea detener la respuesta

Respuesta:

{}
"Dispositivo": 'device_id',
"Status":La simulación del comportamiento se detiene '
}

Suscríbete

Este método se utiliza para suscribir un comando para un dispositivo en particular en una red

Método

Puesto

http://localhost:9000/api/subscribeclient

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para Suscribir un comando para un particular Dispositivo
device_id ID del dispositivo en el que se añade el tema suscrito
Tema Tema que debe ser
qos Nivel de QoS
addtod b Tema suscrito añadido a la base de datos

Respuesta:

{}
"Dispositivo": 'device_id', 'Status':Tema está suscrito

Obtener detalles de suscripción

Este método se utiliza para recuperar los detalles de suscripción de un dispositivo particular en una red

Método

Vamos.

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

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para recuperar los detalles de la suscripción de un particular Dispositivo
device_id ID del dispositivo desde el cual los detalles de la suscripción son recuperado

Respuesta:

{}
"network_name":network_chosen,
"Dispositivo": 'device_id',
'topics': ['topic1','topic2']

Add New Subscribe

Este método se utiliza para agregar un nuevo tema de suscripción para un dispositivo particular en una red

Método

Puesto

http://localhost:9000/api/addsubscribe

Respuesta:

{}
"network_name":network_chosen,
"Dispositivo": 'device_id',
"Subscription_details": "Subscribe_On": cuando_to_subscribe, "Command_Topic": tema, "QoS": QoS, "Command_ID"
}

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para agregar un nuevo comando para un particular Dispositivo
device_id ID del dispositivo en el que el tema suscrito debe ser añadido
Tema Tema que está suscrito recientemente
qos Nivel de QoS

Respuesta:

{}
"Dispositivo": 'device_id',
"Status":Command Topic se añade a la base de datos con éxito '
}

Eliminar Suscríbanse

Este método se utiliza para eliminar un comando de un dispositivo en particular en una red.

Método

Puesto

http://localhost:9000/api/removesubscribe

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para eliminar un comando de un particular Dispositivo
device_id ID del dispositivo en el que la suscripción debe ser Retirada
Tema Tema de suscripción eliminado

Respuesta:

{}
"Dispositivo": 'device_id',
'Status':Command Topic es eliminado de la base de datos '
}

Suscripción Todos

Este método se utiliza para cancelar todos los comandos en una red

Método

Puesto

http://localhost:9000/api/unsubscribeall

Parámetro:

PARAMETER VALUE DETAIL
network_chosen Elija una red para cancelar todos los comandos
device_id ID del dispositivo en el que la suscripción debe ser Retirada
Tema Tema de suscripción eliminado

Respuesta:

{}
"Status": Todos los temas del dispositivo conectado son sin suscripción '
}

Tener dudas sobre Bevywise
¿Simulador de IoT?

Explore nuestra FAQ Página