WISE-Agent - Revision history

Scott68.chang at 05:58, 28 September 2017

2017-09-28T05:58:04Z

Scott68.chang at 05:57, 28 September 2017

2017-09-28T05:57:32Z

Scott68.chang at 01:00, 26 May 2017

2017-05-26T01:00:10Z

Scott68.chang at 00:57, 26 May 2017

2017-05-26T00:57:04Z

Scott68.chang at 00:54, 26 May 2017

2017-05-26T00:54:42Z

Scott68.chang: Add source code reference

2017-03-20T06:02:22Z

Add source code reference

Scott68.chang at 02:00, 6 October 2016

2016-10-06T02:00:02Z

Scott68.chang at 05:48, 4 October 2016

2016-10-04T05:48:25Z

Scott68.chang at 05:21, 4 October 2016

2016-10-04T05:21:30Z

Scott68.chang at 05:16, 4 October 2016

2016-10-04T05:16:37Z

@@ Line 142: / Line 142: @@
 *[[Media:WISE-PaaS_RMM_3.2_AgentTester_UM_V1.0.pdf|<big><big>''RMM 3.2 WISE-Agent AgentTester User Manual''</big></big>]]
 *[[Media:WISE-PaaS_RMM_3.2_WISE-Agent_DG_V1.0_20160930.pdf|<big><big>''RMM&nbsp;3.2&nbsp;WISE-Agent Developer Guide''</big></big>]]
-*[[Media:WISE-PaaS RMM 3.3 WISE-Agent Command Format DG V1.4.pdf|<big><big>''RMM 3.3&nbsp;WISE-Agent Command Format Developer Guide''</big></big>]]
+*[[Media:WISE-PaaS_RMM_3.3_WISE-Agent_Command_Format_DG_V1.4.pdf|<big><big>''RMM 3.3&nbsp;WISE-Agent Command Format Developer Guide''</big></big>]]
-*[Media:WISE-PaaS RMM 3.3 WISE-Agent DG V1.4.pdf|<big><big>''RMM&nbsp;3.3&nbsp;WISE-Agent Developer Guide''</big></big>]]
+*[[Media:WISE-PaaS_RMM_3.3_WISE-Agent_DG_V1.4.pdf|<big><big>''RMM&nbsp;3.3&nbsp;WISE-Agent Developer Guide''</big></big>]]

← Older revision		Revision as of 05:57, 28 September 2017
Line 142:		Line 142:
	*[[Media:WISE-PaaS_RMM_3.2_AgentTester_UM_V1.0.pdf\|<big><big>''RMM 3.2 WISE-Agent AgentTester User Manual''</big></big>]]		*[[Media:WISE-PaaS_RMM_3.2_AgentTester_UM_V1.0.pdf\|<big><big>''RMM 3.2 WISE-Agent AgentTester User Manual''</big></big>]]
	*[[Media:WISE-PaaS_RMM_3.2_WISE-Agent_DG_V1.0_20160930.pdf\|<big><big>''RMM 3.2 WISE-Agent Developer Guide''</big></big>]]		*[[Media:WISE-PaaS_RMM_3.2_WISE-Agent_DG_V1.0_20160930.pdf\|<big><big>''RMM 3.2 WISE-Agent Developer Guide''</big></big>]]
		+	*[[Media:WISE-PaaS RMM 3.3 WISE-Agent Command Format DG V1.4.pdf\|<big><big>''RMM 3.3 WISE-Agent Command Format Developer Guide''</big></big>]]
		+	*[Media:WISE-PaaS RMM 3.3 WISE-Agent DG V1.4.pdf\|<big><big>''RMM 3.3 WISE-Agent Developer Guide''</big></big>]]

@@ Line 11: / Line 11: @@
 Each plugin can be&nbsp;designed to handle specific jobs, such as:
-*'''Sensor Plugin''': the plugin&nbsp;access sensor data through&nbsp;'''Sensor driver'''&nbsp;or&nbsp;'''3rd party library''', or
+*'''Sensor Plugin''': the plugin&nbsp;access sensor data through&nbsp;'''Sensor driver'''&nbsp;or&nbsp;'''3rd party library'''.
 *'''Remote Control Plugin''':&nbsp; the plugin execute remote command on target device.

← Older revision		Revision as of 00:57, 26 May 2017
Line 1:		Line 1:
−	'''WISE ~~Agnet~~ – a software development framework to communicate between device and RMM Server.'''<br/>Advantech provides a software development framework to communicate and exchange information between a device and RMM Server, called a WISE Agent framework.<br/>The WISE Agent framework provides a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and makes agent application easier and simpler to communicate with RMM Server.<br/>The framework has three benefits:	+	'''WISE Agent – a software development framework to communicate between device and RMM Server.'''<br/>Advantech provides a software development framework to communicate and exchange information between a device and RMM Server, called a WISE Agent framework.<br/>The WISE Agent framework provides a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and makes agent application easier and simpler to communicate with RMM Server.<br/>The framework has three benefits:

	*Standardization - The communication protocol is based on the [http://mqtt.org/ MQTT protocol] to communicate and exchange data with WISE-PaaS/RMM Server. The IoT sensor data report format is following the [http://www.ipso-alliance.org/ IPSO Spec.] in [http://www.json.org/ JSON format].		*Standardization - The communication protocol is based on the [http://mqtt.org/ MQTT protocol] to communicate and exchange data with WISE-PaaS/RMM Server. The IoT sensor data report format is following the [http://www.ipso-alliance.org/ IPSO Spec.] in [http://www.json.org/ JSON format].

@@ Line 69: / Line 69: @@
 *'''Modbus Handler''' - version 2.0 only support Modbus-TCP, Modbus-RTU supported since version 3.0.
-'''Modbus handler''' is one of handlers in WISE Agent framework and is used to collect devices’ data based on Modbus TCP protocol.<br/>The library used in Modbus handler is [http://libmodbus.org/documentation/ libmodbus], which is a 3rd party free library to send/receive data according to the Modbus protocol.<br/>This library is written in C and supports RTU (serial) and TCP (Ethernet) communication. The license of libmodbus is LGPL v2.1v.
+'''Modbus handler''' is one of handlers in WISE Agent framework and is used to collect devices’ data based on Modbus TCP protocol.<br/>The library used in Modbus handler is [http://libmodbus.org/documentation/ libmodbus], which is a 3rd party free library to send/receive data according to the Modbus protocol.<br/>This library is written in C and supports RTU (serial) and TCP (Ethernet) communication. The license of libmodbus is LGPL v2.1.
 The flow of WISE Agent communicating with a device based on Modbus by Modbus handler is described as follows.<br/>The WISE Agent uses the Modbus handler as the interface to handle all the communication with the device based on Modbus protocol.

← Older revision		Revision as of 06:02, 20 March 2017
Line 130:		Line 130:

	<span style="font-size:larger;">'''AgentTester – a software tool for testing all sorts of functions and modules of the Agent.'''</span>		<span style="font-size:larger;">'''AgentTester – a software tool for testing all sorts of functions and modules of the Agent.'''</span>
		+
		+	== Source Code ==
		+
		+	*[https://github.com/ADVANTECH-Corp/WISEAgent <big><big>''https://github.com/ADVANTECH-Corp/WISEAgent''</big></big>]

	== Document ==		== Document ==

← Older revision		Revision as of 02:00, 6 October 2016
Line 137:		Line 137:
	*[[Media:WISE-PaaS_RMM_3.1_WISE-Agent_Command_Format_DG_V1.2.pdf\|<big><big>''RMM 3.1 WISE-Agent Command Format Developer Guide''</big></big>]]		*[[Media:WISE-PaaS_RMM_3.1_WISE-Agent_Command_Format_DG_V1.2.pdf\|<big><big>''RMM 3.1 WISE-Agent Command Format Developer Guide''</big></big>]]
	*[[Media:WISE-PaaS_RMM_3.2_AgentTester_UM_V1.0.pdf\|<big><big>''RMM 3.2 WISE-Agent AgentTester User Manual''</big></big>]]		*[[Media:WISE-PaaS_RMM_3.2_AgentTester_UM_V1.0.pdf\|<big><big>''RMM 3.2 WISE-Agent AgentTester User Manual''</big></big>]]
		+	*[[Media:WISE-PaaS_RMM_3.2_WISE-Agent_DG_V1.0_20160930.pdf\|<big><big>''RMM 3.2 WISE-Agent Developer Guide''</big></big>]]

@@ Line 1: / Line 1: @@
 '''WISE Agnet – a software development framework to communicate between device and RMM Server.'''<br/>Advantech provides a software development framework to communicate and exchange information between a device and RMM Server, called a WISE Agent framework.<br/>The WISE Agent framework provides a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and makes agent application easier and simpler to communicate with RMM Server.<br/>The framework has three benefits:
@@ Line 21: / Line 19: @@
 == Architecture ==
 In '''WISE Agent Framework''', it includes two parts: '''WISE Agent''' and '''Handlers'''.

← Older revision		Revision as of 05:21, 4 October 2016
Line 46:		Line 46:

	[[File:WISEAgentArchitecture.png\|760x600px\|WISEAgent SW Architecture]]		[[File:WISEAgentArchitecture.png\|760x600px\|WISEAgent SW Architecture]]
−
−	~~=== Plugins ===~~
−
−	~~In Plugin (Handler) Architecture, the '''Plugin (Handler) APIs''' is the skin of Plugin. The WISE Agent Handler loader will link the pre-defined APIs dynamically.~~
−
−	The '''Handler Kernel''' Library is the bone of the Plugin. This library will handle most of the functions in a Plugin, Such as: Gat Capability, Auto Report Start/Stop, Get/Set Sensor Data and basic Threshold Rule support.
−
−	The '''Message Structure''' is the main structure to describe the sensor data and interact between '''Handler Kernel''' and '''Custom Data Access'''. In '''Handler Kernel''', the library will generate the handshake message based on the '''Message Structure'''.
−
−	~~The '''Message Generator''' library provides several APIs to describe the custom sensor data in a '''Message Structure'''.~~
−
−	In the '''Custom Data Access''' block, user needs to implement the function to access data from '''3<sup>rd</sup> party library''' or '''drivers''' in platform. And update the sensor data in '''Message Structure''' to report those data to the RMM Server through '''Handler Kernel'''.
−
−	~~[[File:Handler Arch.png\|588x360px\|RTENOTITLE]]~~

	== [[WISE-Agent_Sample_Client\|WISE-Agent Sample Client]] ==		== [[WISE-Agent_Sample_Client\|WISE-Agent Sample Client]] ==

← Older revision		Revision as of 05:16, 4 October 2016
Line 148:		Line 148:

	<span style="font-size:larger;">'''AgentTester – a software tool for testing all sorts of functions and modules of the Agent.'''</span>		<span style="font-size:larger;">'''AgentTester – a software tool for testing all sorts of functions and modules of the Agent.'''</span>
−
−
−
−	~~<span style="font-size:larger;"><span style="font-family:arial,helvetica,sans-serif;">'''Architecture'''</span></span>~~
−
−	~~The architecture of AgentTester is described as follows. The agent includes three different layers: Main, Module and Library.~~
−
−	~~ ~~
−
−	*'''Main Layer'''
−
−	~~               The main executable function to load all the modules required to test functions of an agent.~~
−
−	*'''Module Layer:'''
−
−	~~               All modules used to test functions of an agent.~~
−
−	*'''Library Layer:'''
−
−	~~               All libraries required in modules.~~
−
−	~~[[File:AgentTester.png\|760x600px\|Architecture of AgentTester]]~~
−
−	~~ ~~
−
−	~~<span style="font-family:arial,helvetica,sans-serif;"><span style="font-size:larger;">'''Configuration'''</span></span>~~
−
−	AgentTester takes an INI file (CheckerSetting.ini) as its configuration to know which modules are required to test an agent according to a user’s requirements. User can modify INI file to load or unload modules for meeting his/her wanted test conditions.
−
−	~~ ~~
−
−	*''' Modules Section'''
−
−	~~               This section is used to define how many and which modules required to load. And the required operation time for the module.~~
−
−	*'''Server Section'''
−
−	~~               This section describes the server setting, which must be as same as agent_config.xml with your test target.~~
−
−	*'''Reconnect_Server Section'''
−
−	The section for ServerRedCK to test server redundancy. The setting consists of the configuration of a slave server to reconnect. (only support the same server as [Server])
−
−	*'''Device Section'''
−
−	~~                The section defines DeviceID.~~
−
−	*'''Topics Section'''
−
−	The section describes a topic to subscribe. (only one topic allowed, use '+' to receive messages as many as possible)
−
−	*'''HandlerList Section'''
−
−	~~                The section describes a list to test handler list.~~
−
−	*'''Capability Section'''
−
−	~~                The section describes a list of handlers has to go through capability test.~~
−
−	*'''Report-Upload-Get Section'''
−
−	~~                The section describes a list of handlers has to go through report, upload and get test.~~
−
−	*'''Set Section'''
−
−	~~                The section describes a list of handlers has to go through set test.~~
−
−	~~<span style="font-family:arial,helvetica,sans-serif;"><span style="font-size:larger;">'''Modules'''</span></span>~~
−
−	~~This section introduces all modules called Checkers in AgentTest used to test functions of an agent.~~
−
−	~~ ~~
−
−	*'''ConnetionCK'''
−
−	~~                The module is used to check connection functions of an agent such as reconnect function.~~
−
−	*'''GHandlerCapRepCk'''
−
−	~~                The module checks general handler’s functions including capability and reported data.~~
−
−	*'''HandlerCapGetSetUploadCK'''
−
−	~~                The Checker tests handler’s functions including capability, get, set and upload.~~
−
−	*'''HandlerLSCK'''
−
−	~~                The Checker checks handler list to know what handler an agent loads.~~
−
−	*'''ServerRedCK'''
−
−	~~                The Checker tests ServerRedundancyHandler’s functions including reconnect function and others.~~
−
−	*'''AServiceCK'''
−
−	~~                The Checker checks agent service’s status and functions.~~
−
−	*'''WatchDogCK'''
−
−	~~                The Checker checks WatchDog’s status and functions such as restarting a killed agent.~~
−
−	*'''IoTGWCK'''
−
−	~~                The Checker checks IoTGWHandler’s functions and the sensor hubs under the gateway.~~
−
−	*'''AProcessCK'''
−
−	~~                The Checker continuously checks agent process’s status.~~
−
−
−
−	All the modules above can be loaded or unloaded according to a user’s requirements or test conditions. By setting a suitable ini configuration, the test result could be simple and easy-to-read, no redundancy report would show.

	== Document ==		== Document ==