NewportOmega

README

b"Newport's Omega\n===============\n\nThe content of this repository has been prepared to control a Newport's \ninstrument to measure strain gage. \nIt would be extended to other instruments from the same series that have the \nsame way to control.\n\nThis code can be found in two (mirrored) locations, in github\n as a repository and in sourceforge\n as a subdirectiory of tango-ds project.\n\n In the src directory there is a basic file called OmegaCommunications.py. \n This is the main file that supports the communications with the instrument \n and encapsulates the different methods to connect. By now it requires \n tausus, but this may change in a short \n future to minimise the dependencies.\n \n Apart from this file, there is another called newportomega.py that \n has been generated by pogo\n and its methods has been adjusted to use the class in the previous mentioned\n file (OmegaCommunications.py) to thurst the readings into an instance on \n the tango control system.\n \nUsage\n-----\n \n Stand alone use can be made by command line calls of the \n OmegaCommunications.py file:\n\n$ python OmegaCommunications.py -h\nUsage: OmegaCommunications.py [options]\n\nOptions:\n -h, --help show this help message and exit\n -s SERIAL, --serial=SERIAL\n String with the reference name to use for serial line\n connection.\n -a ADDRESS, --address=ADDRESS\n Two digit string with the address of the OMEGA.\n -t SLEEP, --sleep=SLEEP\n Wait time between write and read operations\n --log-level=LOG_LEVEL\n Define the logging level to print out. Allowed values\n error|warning|info|debug, being info the default\n -r READS, --reads=READS\n Number of consecutive sets of readings\n\n\nAn execution example can be:\n\n\n$ python OmegaCommunications.py -s /dev/ttyr00 -a 01 -t 0.1 --log-level=Debug\nMainThread DEBUG 2014-12-23 11:59:39,416 OMEGA: sending: '*01X01\\r'\nMainThread DEBUG 2014-12-23 11:59:39,665 OMEGA: received ''\nMainThread DEBUG 2014-12-23 11:59:39,916 OMEGA: received '01X01090.252\\r'\nMainThread DEBUG 2014-12-23 11:59:39,916 OMEGA: Answer string: '090.252'\nMainThread DEBUG 2014-12-23 11:59:39,917 OMEGA: sending: '*01X02\\r'\nMainThread DEBUG 2014-12-23 11:59:40,169 OMEGA: received ''\nMainThread DEBUG 2014-12-23 11:59:40,421 OMEGA: received '01X02090.378\\r'\nMainThread DEBUG 2014-12-23 11:59:40,421 OMEGA: Answer string: '090.378'\nMainThread DEBUG 2014-12-23 11:59:40,422 OMEGA: sending: '*01X03\\r'\nMainThread DEBUG 2014-12-23 11:59:40,672 OMEGA: received ''\nMainThread DEBUG 2014-12-23 11:59:40,924 OMEGA: received '01X03069.042\\r'\nMainThread DEBUG 2014-12-23 11:59:40,925 OMEGA: Answer string: '069.042'\nMainThread DEBUG 2014-12-23 11:59:40,925 OMEGA: sending: '*01X04\\r'\nMainThread DEBUG 2014-12-23 11:59:41,176 OMEGA: received ''\nMainThread DEBUG 2014-12-23 11:59:41,429 OMEGA: received '01X04090.313\\r'\nMainThread DEBUG 2014-12-23 11:59:41,429 OMEGA: Answer string: '090.313'\nread: 1/1\nUnfiltered Value: 90.252\nFiltered: 90.313\nPeak: 90.378\nValley: 69.042\n\n\nWith this command it has been used a tty file (in this case a \nmoxa remote port but a subdevice \nfrom tango can be used. From the serial line device server currently available \noptions it has been tested using the \nPySerial\n but the C++ option for \n serial\n communication will be supported also in a near future.\n\n### Tango device server\n\nAbout the other important file, the newportomega.py, it can be \nlaunched having a tango control system middleware infrastructure installed.\n\nFor such thing, a new device server instance has to be created and the device \nthat will be in charge of this instrument in the distributed control system \nrequires a few properties.\n\n * Serial: (Mandatory) String with the reference name to use for serial \n line connection.\n * Address: (if required) Two digit string with the address of the OMEGA.\n * Measures: List of elements to read from the instrument: UnfilteredValue, \n FilteredValue, PeakValue, ValleyValue.\n\nWith this last property, dynamic attributes will be created for each of the \nmeasurements that are requested to made by the instrument\n\nWish list\n---------\n\nBy now only the state and the status have events. In a near future all the \nmeasure attributes shall have also. This will require a reading loop to the \ninstrument that will manage the reading period to avoid stress the instrument.\n\nAs mention before, it's also in this list the support to the C++ Serial \ntango device server.\n\nThe dependency to taurus for logging, shall be changed to tango logging \nto reduce dependency. And wouold be good to have an stand alone alternative if \nit's tango what is not installed.\n\nExtend the commands supported to communicate with the instrument.\n\nTest and extend reliability and error messaging using the device status \nstring message.\n\nQualities to the attributes. Like changing when readings changes above the \nnoise (noise definition required).\n\nMeasurement units to the Tango attributes.\n"