diff --git a/CHANGELOG.md b/CHANGELOG.md index d875352a95a2e6e25544a06fa39e11ad1d821332..8b6a37ab38874345970d26933f822c35d54e92a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,10 +46,18 @@ - Added MessageTrigger scripts to use the jar without dependencies within the control network. ## [1.0.4] - 22/06/2020 + ### This version was not committed, it was developed during the tests within RCM1 ## [1.0.3] - 11/05/2020 +### Overhauled the whole communication system with TangoParsers, allowing for monitoring of several parsers at the same time. + +### Removed +- Removed "TangoParserProxy" property, as it is no longer necessary + +## [1.0.2] - 07/06/2020 + ### Changed - LastStates are now initialized with the actual states at init, so that no message is sent during init. - Changed the way "MessageList" property is parsed @@ -60,11 +68,5 @@ ### Removed - Removed "LastRecordedState" property, as it is useless in this new MessageTrigger. -## [1.0.2] - 07/06/2020 -### Overhauled the whole communication system with TangoParsers, allowing for monitoring of several parsers at the same time. - -### Removed -- Removed "TangoParserProxy" property, as it is no longer necessary - ## [1.0.1] - 30/04/2020 ### First version of the device \ No newline at end of file diff --git a/README.md b/README.md index ef94e6520fba04c061671c52d3259e136d7d85c0..7b8324ea6bcdf9e873a8fd82452b1761242781de 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,29 @@ -# Welcome to Tango-Controls server MessageTrigger +# Welcome to Tango-Controls server MessageTrigger v1.1.0 +## Description + +The MessageTrigger is a device design to poll regularly the attributes of TangoParser sub devices, and send a message to a TextTalker sub device if a change occured. + +It is possible to monitor several TangoParser devices with one MessageTrigger device. The configuration is done through the properties of the device: + +### MessageList property + +This property contains the list of attributes to monitor and the messages to send. This property is mandatory. + +``` +test/test/parser1/attribute1;Attribute 1 is true!;Attribute 1 is false!; +test/test/parser1/attribute2;Attribute 2 is true!;Attribute 2 is false!; +``` + +### PollingPeriod property + +This property is the polling period of the monitoring, in ms. This property is not mandatory, default period is 1s. + +### TextTalkerProxyName + +This property should contain the address of the TextTalker device the message will be sent to. This property is mandatory. + +## Usage Clone this repo and build an executable jar with dependencies using maven: