mwavepy.virtualInstruments.generalSocketReader | index /home/alex/docs/python/path/mwavepy/virtualInstruments/generalSocketReader.py

`# generalSocketReader.py
#
# Copyright 2011 alex arsenovic <arsenovic@virginia.edu>
#
# 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.`

Modules
`` |  |
numpy | socket |  |

Classes
`` |  | GeneralSocketReader
class GeneralSocketReader
`` | `A general class which wraps a socket and has a simple data query function, implemented by the property data_point. this was made as a way to interface a piece of hardware which did not support gpib. is useful for general interfacing of non-standard hardware or software. example usage: gsr = generalSocketRead() gsr.connect('127.0.0.1',1111) gsr.data_point # implicityly calls send() then receive()`
| Methods defined here: __init__(self, sock=None, sample_rate=2.5, avg_len=1, query_string='1', msg_len=1000.0) `takes: sock: socket type (defaults to None and generates a new socket) query_string: string sent during send() command msg_len: length of recv buffer used in receive() command` close(self) connect(self, host, port) receive(self) send(self, data) Data descriptors defined here: data `tmp = [] for n in range(self.avg_len): sleep(1./self.sample_rate) send(self.query_string) tmp.append(float(receive())) return npy.mean(tmp)`

Functions
`` |  | sleep(...) `sleep(seconds) Delay execution for a given number of seconds. The argument may be a floating point number for subsecond precision.`