Bevywise IoT Simulator API Documentation

Introduction:

 The API method presented in this document can be used to communicate with Bevywise IoT Simulator to Create and Remove Network and Clients, to Create Events and Publish for the added Clients, to Create and Remove Subscription to the added clients, to Create and Remove Response for the added Clients. 

Add a New Device

This method will add a new MQTT Device to an already running simulator. The Clean session , will message ,will QoS, will retain etc can be specified as part of this method.

Method:

POST

http://localost:9000/api/addclient

Parameter:

Response:

											
  {  										
    '“Device”:device_id',
    '“Status”:Device is added to database and connected with broker'
  }

Remove the Connected Device

This method will help you to remove the MQTT Device which was connectd to the simulator.

Method

GET

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

Parameter:

Response:

												  
  { 
        '“Status”:Client is removed'
  }

Start Device

This method will start the Deivce by connecting it to the Broker.

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network”:network_chosen',
    '“Device”:Device_ID',
    '“status”:Device is Started'
  }

Stop Device

This method will stop the Device by disconnecting it from the Broker.

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network”:network_chosen',
    '“Device”:Device_ID',
    '“status”:Device is Stopped'
  }

Get Device list

This method will Displays the Device list in a network .

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“device list”: [{"ID":“Device ID,"Name":device_name,"Discription":Description}',
    '{"ID":device_id,"Name":Device_name,"Description":Description},..]'
  }

Get Device Details

This method will Displays the details of a particular Device in a network .

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '"device":Device_ID',
    '"Will_Details":{}',
    '"Auth_details":[{ 'auth key':username, 'auth_token': password}]',
    '"Subscription": [ { } ], "Behavior": [ { } ], "Events": [ { } ]'
  }

Start Network

This method will start a all the Device by connecting it to the Broker

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '"Started":number of device started',
    '"Failed":number of device not started'
  } 

Stop Network

This method will stop a all the device by disconnecting it to the Broker

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '"Stopped_count":number of device disconnected'
  }
 

Get Network List

This method will list all the network created in the Simulator

Method

GET

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

Response:

												  
  { 
    '“network_list”:[ { } ]'
  }
 

Get Network Status

This method will show the status of the given network

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Running”:number of device connected',
    '“Not_Running”:number of device not connected'
  }
 

Choose a Network

This method will used to Choose a network for api integration

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Status”:Network was Chosen'
  }
 

Stop Event

This method will used to stop the publishing events

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Event_ID”:event_id',
    '“Status”:Event is stopped'
  }
 

Resume Event

This method will used to resume the stopped events

Method

GET

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

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Event_ID”:event_id',
    '“Status”:Event is resume'
  }
 

Publish

This method will used Publish events for a particular device in a network

Method

POST

http://localhost:9000/api/pubishclient

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Topic”:topic',
    '“Status”:Published',
    '“Message”:message',
    '“Published at”:time_of_publish',

  }
 

Publish_with_Error

This method will used to Publish corrupted event for a particular Device in a network

Method

POST

http://localhost:9000/api/publishclient_with_corruption

Parameter:

Response:

												  
  { 
    '“network_name”:network_chosen',
    '“Topic”:topic',
    '“Status”:Published',
    '“Message”:message',
    '“Published at”:time_of_publish',

  }
 

Remove Publish Message

This method will used to remove the event topic from a particular Device in a network

Method

POST

http://localhost:9000/api/removepublish

Parameter:

Response:

												  
  { 
    '“Device”:Device_ID',
    '“Status”:Event Topic is removed from database'
  }
 

Add Response for Request

This method will used to Add a new behavior pattern for a particular Device in a network

Method

POST

http://localhost:9000/api/addresponse

Parameter:

Response:

												  
  { 
    '“Device”:Device_ID',
    '“Status”:Request Response Message is added successfully'
  }
 

Remove Response for Request

This method will used to Remove a behavior pattern from a particular Device in a network

Method

POST

http://localhost:9000/api/removeresponse

Parameter:

Response:

												  
  { 
    '“device”:Device_ID',
    '“Status”:Behavior Pattern is removed from database'
  }
 

Stop Behavior Simulation

This method will used to Stop a behavior pattern from a particular Device in a network

Method

POST

http://localhost:9000/api/stopres

Parameter:

Response:

												  
  { 
    '“Device”:Device_ID',
    '“Status”:Behavior Simulation is stopped'
  }
 

Subscribe

This method will used to Subscribe a command for a particular device in a network/p>

Method

POST

http://localhost:9000/api/subscribeclient

Parameter:

Response:

												  
  { 
    '“device”:Device_ID',
    '“Status”:Topic is subscribed'
  }
 

Get Subscription Details

This method will used to Retrieve the subscription details of a particular device in a network/p>

Method

GET

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

Parameter:

Response:

												  
  { 
    
    '“network_name”:network_chosen',
    '"Device":device_ID',
    '"Subscription_details":[{ "Subscribe_On": when_to_subscribe, "Command_Topic": topic, "QoS": QoS, "Command_ID": topic_id},{ }]',
  }
 

Add New Subscribe

This method will used to Add a new command for a particular Device in a network/p>

Method

POST

http://localhost:9000/api/addsubscribe

Parameter:

Response:

												  
  { 
    '“Device”:device_ID',
    '“Status”:Command Topic is added to database successfully'
  }
 

Remove Subscribe

This method will used to Remove a command from a particular Device in a network/p>

Method

POST

http://localhost:9000/api/removesubscribe

Parameter:

Response:

												  
  { 
    '“Device”:Device_ID',
    '“Status”:Command Topic is removed from database'
  }
 

Unsubscribe

This method will used to Unsubscribes a command from a particular device in a network

Method

POST

http://localhost:9000/api/unsubscribe

Parameter:

Response:

												  
  { 
    '“Device”:Device_ID',
    '“Topic”:topic',
    '“Status”:Topic is unsubscribed'
  }
 

Unsubscribe All

This method will used to Unsubscribes all commands in a network

Method

POST

http://localhost:9000/api/unsubscribeall

Parameter:

Response:

												  
  { 
    '“Status”:All topics of connected Device are unsubscribed'
  }