| @@ -1,38 +1,39 @@ | |||||
| # Python class for Rainforest Eagle | # Python class for Rainforest Eagle | ||||
| Python Class for utilizing the Rainforest Automation Eagle ( RFA-Z109 ) socket API | Python Class for utilizing the Rainforest Automation Eagle ( RFA-Z109 ) socket API | ||||
| import import RainEagle | |||||
| Example : | |||||
| ```python | |||||
| import RainEagle | |||||
| raineagle = RainEagle.Eagle( debug=0 , addr="10.1.1.39") | raineagle = RainEagle.Eagle( debug=0 , addr="10.1.1.39") | ||||
| ret_data = eg.list_devices() | ret_data = eg.list_devices() | ||||
| print "device MacID = ", ret_data['DeviceInfo']['DeviceMacId'] | print "device MacID = ", ret_data['DeviceInfo']['DeviceMacId'] | ||||
| ``` | |||||
| API Calls | |||||
| API Call list : | |||||
| ```python | ```python | ||||
| list_devices() | |||||
| get_demand_values(macid=None, interval='hour', frequency=None) | |||||
| get_device_data(macid=None) | |||||
| get_fast_poll_status(macid=None) | |||||
| get_history_data(macid=None, starttime='0x00000000', endtime=None, frequency=None) | |||||
| get_instantaneous_demand(macid=None) | |||||
| get_summation_values(macid=None, interval='day') | |||||
| set_fast_poll(macid=None, frequency='0x04', duration='0xFF') | |||||
| list_devices() | |||||
| get_demand_values(macid=None, interval='hour', frequency=None) | |||||
| get_device_data(macid=None) | |||||
| get_fast_poll_status(macid=None) | |||||
| get_history_data(macid=None, starttime='0x00000000', endtime=None, frequency=None) | |||||
| get_instantaneous_demand(macid=None) | |||||
| get_summation_values(macid=None, interval='day') | |||||
| set_fast_poll(macid=None, frequency='0x04', duration='0xFF') | |||||
| ``` | ``` | ||||
| # Automation Documentation | |||||
| Calls return dictionarys containing data results | |||||
| * Developer Portal http://rainforestautomation.com/developer | |||||
| ## External Documentation | |||||
| * Developer Portal http://rainforestautomation.com/developer | |||||
| * socket interface API http://rainforestautomation.com/sites/default/files/docs/eagle_socket_api_09.pdf | * socket interface API http://rainforestautomation.com/sites/default/files/docs/eagle_socket_api_09.pdf | ||||