diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5057509 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.DS_Store +*.pyc +build +dist +*.egg-info diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8cdb845 --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e347f5f --- /dev/null +++ b/README.md @@ -0,0 +1,107 @@ +# baratron + +Python driver and command line tool for ToolWeb-enabled [MKS eBaratron capacitance manometers](http://www.mksinst.com/product/category.aspx?CategoryID=72). + +

+ +

+ +Installation +============ + +``` +pip install baratron +``` + +If you don't like pip, you can also install from source: + +``` +git clone https://github.com/numat/baratron.git +cd baratron +python setup.py install +``` + +Usage +===== + +###Command Line + +To test your connection and stream real-time data, use the command-line +interface. You can read the state with + +``` +$ baratron 192.168.1.100 +{ + "full-scale pressure": 1000.0, + "led color": "green", + "pressure": 746.07721, + "pressure units": "torr", + "run hours": 29.66111111111111, + "system status": "ok", + "wait hours": 0.0 +} +``` + +or stream a table of data with the `--stream` flag. See `baratron --help` +for more. + +###Python + +For more complex behavior, use the python interface. + +```python +from baratron import CapacitanceManometer +cm = CapacitanceManometer("192.168.1.100") +print(cm.get()) +``` + +If the device is operating at that IP address, this should return an output +a dictionary of the form: + +```python +{ + "full-scale pressure": 1000.0, # Maximum pressure + "led color": "green", # Can be green, yellow, red, and blinking + "pressure": 746.08, # Current (digital) pressure + "pressure units": "torr", # Units of pressures + "run hours": 29.66, # Hours since powered on + "system status": "ok", # If not ok, displays error message + "wait hours": 0.0 # If non-zero, the system is heating up +} +``` + +These are the default returned fields. The device can return a few additional +fields, but they are disabled by default (they're generally redundant). + +Asynchronous +============ + +The above example works for small numbers of sensors. At larger scales, +the time spent waiting for sensor responses is prohibitive. Asynchronous +programming allows us to send out all of our requests in parallel, and then +handle responses as they trickle in. For more information, read through +[krondo's twisted introduction](http://krondo.com/?page_id=1327). + +```python +from baratron import CapacitanceManometer +from tornado.ioloop import IOLoop, PeriodicCallback + + +def on_response(response): + """This function gets run whenever the device responds.""" + print(response) + + +def loop(): + """This function will be called in an infinite loop by tornado.""" + cm.get(on_response) + + +cm = CapacitanceManometer() +PeriodicCallback(loop, 500).start() +IOLoop.current().start() +``` + +This looks more complex, but the advantages are well worth it at scale. +Essentially, sleeping is replaced by scheduling functions with tornado. This +allows your code to do other things while waiting for responses. diff --git a/baratron/__init__.py b/baratron/__init__.py new file mode 100644 index 0000000..365c33d --- /dev/null +++ b/baratron/__init__.py @@ -0,0 +1,172 @@ +#!/usr/bin/python +""" +Python driver for MKS eBaratron capacitance manometers, using ToolWeb. + +Distributed under the GNU General Public License v2 +Copyright (C) 2015 NuMat Technologies +""" +import xml.etree.ElementTree as ET + +from tornado.httpclient import HTTPRequest, HTTPClient, AsyncHTTPClient + + +class CapacitanceManometer(object): + """Python driver for MKS eBaratron capacitance manometers. + + More information on the device can be found [here] + (http://www.mksinst.com/product/category.aspx?CategoryID=72). + + This class uses a tornado event loop to asynchronously retrieve data from + the device. This can be used as an independent loop, registered with a + larger loop, or simply ignored and used synchronously. + """ + evids = {'pressure': 'EVID_100', + 'analog pressure': 'EVID_101', + 'run hours': 'EVID_102', + 'digital pressure, fraction of full scale': 'EVID_103', + 'analog pressure, fraction of full scale': 'EVID_104', + 'pressure units': 'EVID_105', + 'led color': 'EVID_106', + 'wait hours': 'EVID_107', + 'fw update (factory reserved)': 'EVID_110', + 'fw sec (factory reserved)': 'EVID_111', + 'refresh rate (website)': 'EVID_112', + 'offset (non-functional)': 'EVID_113', + 'drift': 'EVID_114', + 'zero (non-functional)': 'EVID_115', + 'disp res (website)': 'EVID_116', + 'plot data (website)': 'EVID_117', + 'rtp data (factory reserved)': 'EVID_118', + 'time (factory reserved)': 'EVID_198', + 'reset service (factory reserved)': 'EVID_199', + 'system status': 'EVID_208', + 'full-scale pressure': 'EVID_1103'} + pressure_units = ['full-scale ratio', 'psi', 'torr', 'mtorr', 'cmH2O', + 'inHg', 'inH2O', 'bar', 'mbar', 'Pa', 'kPa', 'atm', + 'g / cm2'] + led = ['red', 'green', 'yellow', None, 'blinking'] + status = [None, + 'Signal Error (ADC0)', + 'Signal Error (ADC1)', + 'Calibration Checksum1 Failure', + 'Calibration Checksum2 Failure', + 'e-Baratron Outside Zeroing Range', + 'Zero Adjusted', + None, None, None, None, + 'Diaphragm Shorted', + 'e-Baratron Over 110% of FS', + None, None, None, + 'Pressure Over Set Limit', + 'Pressure Under Set Limit', + None, None, None, + 'Illegal Access', + None, None, None, None, + 'Power Supply Out of Spec', + 'e-Baratron Zeroing Recommended', + 'Cumulative Adjustment Over 20%', + 'Heater Failure'] + + def __init__(self, address='192.168.1.100'): + """Saves IP address and checks for live connection. + + Args: + address: The IP address of the device, as a string. + Default '192.168.1.100'. + """ + self.address = 'http://{}/ToolWeb/Cmd'.format(address) + + # There's no documented method to change requested data, but it can be + # done with e.g. `capacitance_manometer.fields.append('drift')`. + self.fields = ['pressure', 'run hours', 'pressure units', + 'led color', 'wait hours', 'system status', + 'full-scale pressure'] + self.clients = {"sync": HTTPClient(), "async": AsyncHTTPClient()} + + def get(self, callback=None): + """Retrieves the current state of the device through ToolWeb. + + Args: + callback (Optional): If specified, this function will be triggered + asyncronously on response. + Returns: + If a callback is not specified, this synchronously returns the + state as a dictionary. + """ + ids = (''.format(self.evids[f]) for f in self.fields) + body = '{}'.format(''.join(ids)) + request = HTTPRequest(self.address, 'POST', body=body) + if callback: + self.clients['async'].fetch(request, + lambda r: callback(self._process(r))) + else: + return self._process(self.clients['sync'].fetch(request)) + + def _process(self, response): + """Converts XML sensor response string into a simplified dictionary.""" + if response.error: + raise IOError(response.error) + + state = {} + tree = ET.fromstring(response.body) + for item in tree.findall('V'): + evid, value = item.get("Name"), item.text + key = next(k for k, v in self.evids.items() if v == evid) + if key == 'pressure units': + state[key] = self.pressure_units[int(value)] + elif key == 'system status': + i = int(value) + statuses = ([s for bit, s in enumerate(self.status) + if s and bool(i >> bit & 1)] or ["ok"]) + state[key] = ', '.join(statuses) + elif key == 'led color': + i = int(value) + led_statuses = ([s for bit, s in enumerate(self.led) + if s and bool(i >> bit & 1)] or ["unknown"]) + state[key] = ', '.join(led_statuses) + elif 'pressure' in key: + state[key] = float(value) + elif key in ['run hours', 'wait hours']: + state[key] = float(value) / 3600.0 + else: + state[key] = value + return state + + +def command_line(): + import argparse + import json + from time import time + + parser = argparse.ArgumentParser(description="Read an MKS eBaratron " + "capacitance manometer from the command " + "line.") + parser.add_argument('address', nargs='?', default='192.168.1.100', + help="The IP address of the eBaratron. Default " + "'192.168.1.100'.") + parser.add_argument('--stream', '-s', action='store_true', + help="Sends a constant stream of sensor data, " + "formatted as a space-separated table.") + args = parser.parse_args() + + manometer = CapacitanceManometer(args.address) + + if args.stream: + try: + headers = ["time", "pressure", "units", "max pressure", + "state", "LED color", "run (hours)", "wait (hours)"] + print(''.join('{:<15}'.format(h) for h in headers)) + t0 = time() + while True: + d = manometer.get() + print(("{time:<14.2f} {pressure:<14.1f} {pressure units:<14} " + "{full-scale pressure:<14.0f} {system status:<14} " + "{led color:<14} {run hours:<14.2f} {wait hours:<14.2f}" + ).format(time=time()-t0, **d)) + except KeyboardInterrupt: + pass + else: + print(json.dumps(manometer.get(), indent=2, sort_keys=True)) + + +if __name__ == "__main__": + command_line() diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..5e40900 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..e7b8030 --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +from setuptools import setup + +setup( + name="baratron", + version="0.1.0", + description="Python driver for MKS eBaratron capacitance manometers.", + url="http://github.com/numat/baratron/", + author="Patrick Fuller", + author_email="pat@numat-tech.com", + packages=["baratron"], + install_requires=["tornado"], + entry_points={ + "console_scripts": [("baratron = baratron:command_line")] + }, + license="GPLv2", + classifiers=[ + "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", + "Development Status :: 4 - Beta", + "Natural Language :: English", + "Programming Language :: Python", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 3", + "Topic :: Scientific/Engineering :: Human Machine Interfaces" + ] +)