openioe 1.0.0

Open IoE

Open IoE

Open IoE is a simple IoT platform to operate IoT devices.

There are two options available,

1. Python Library (Client)
2. Web services (REST APIs)

---

1. Python Library

Users are expected to take these steps,

1. Install Python Library

   pip install openioe

2. Write the client code using the following methods

Method List:

No	Method	Description	Example
1	ReadValue	To read the sensor data from single nodes. Type of data is "Numeric/String"	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xxx SensorData,ResposeCode=oi.ReadValue() print(SensorData) print(ResposeCode)
2	WriteValue	To modify the control signal at single nodes. Type of data is "Numeric/String".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xx oi.Data=10 SensorData,ResposeCode=oi.WriteValue() print(SensorData) print(ResposeCode)
3	ReadJSON	To read the sensor data from single nodes. Type of data is "JSON".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xxx SensorData,ResposeCode=oi.ReadJSON() print(SensorData) print(ResposeCode)
4	WriteJSON	To modify the control signal at single nodes. Type of data is "JSON".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xxx oi.DataJSON={'Value': '10'} SensorData,ResposeCode=oi.WriteJSON() print(SensorData) print(ResposeCode)
5	ReadXML	To read the sensor data from single nodes. Type of data is "XML".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xxx SensorData,ResposeCode=oi.ReadXML() print(SensorData) print(ResposeCode)
6	WriteXML	To modify the control signal at single nodes. Type of data is "XML".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.DeviceID=xx oi.DevicePin=xxx oi.DataXML='OpenIoE' SensorData,ResposeCode=oi.WriteXML() print(SensorData) print(ResposeCode)
7	Read	To read the sensor data from multiple nodes. Type of data is "Numeric/String".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.UserIDPinAPIKeys=[[xx, xxx], [x, xxx]] SensorData,ResposeCode=oi.Read() print(SensorData) print(ResposeCode)
8	Write	To modify the control signal at multiple nodes. Type of data is "Numeric/String".	from openioe.openioe_apis import * oi=openioe_apis() oi.APIKey='xxxxxxxxxxxxxxxxxxxx'; oi.UserIDPinAPIKeys=[[xx, xxx], [xx, xxx]] oi.Data=[xx,xx] Confirmation,ResposeCode=oi.ReadAPI() print(Confirmation) print(ResposeCode)
3	Developer	To display the developer information	from openioe.openioe_apis import * oi=openioe_apis() oi.Developer()

---

2. Web Services

Users are expected to take these steps,

1. Register and login to OpenIoE- Register/Login

2. Create API Key/ Get API Key from OpenIoE.

3. Embed the API Key, Device ID and Pin into the client code.

Visit the OpenIoE 3.0 web portal at https://openioe.gnanodaya.org

Visit the OpenIoE 3.0 Help Portal at https://openioedoc.gnanodaya.org

API List:

No	API	Description	Type	Example
1	showdevicevalue	To get hardware value from web service.	http get	<endpoint>/showdevicevalue/<apikey>/2/433
2	updatedevicevalue	Update the hardware value passed as a parameter	http get	<endpoint>/updatedevievalue/<apikey>/2/433/2
3	showdevicejson	To get hardware JSON from web service.	http get	<endpoint>/showdevicejson/<apikey>/2/433
4	updatedevicejson	Update the hardware JSON passed as parameter	http post	<endpoint>/updatedevicejson/<apikey>/2/433 <Data>
5	showdevicexml	To get hardware XML file from web service.	http get	<endpoint>/showdevicexml/<apikey>/2/433
6	updatedevicexml	Update the hardware XML passed as parameter	http post	<endpoint>/updatedevicexml/<apikey>/2/433 <Data>

---

Developers

Thanks and Regards,

Venkataswamy R

Assistant Professor,

Department of Electrical and Electronics Engineering,

School of Engineering and Technology,

Christ (Deemed to be University),

Bengaluru-560074, India

080-4012-9961 (O)   [phone]  venkatswamy.in