ahio  1.0.0
I/O Communication Library
ahio.drivers.generic_tcp_io.Driver Class Reference
Inheritance diagram for ahio.drivers.generic_tcp_io.Driver:
ahio.abstract_driver.AbstractDriver object

Public Member Functions

def __enter__ (self)
 
def __exit__ (self, exc_type, exc_value, traceback)
 
def setup (self, address, port)
 Connects to server at address:port. More...
 
def available_pins (self)
 
def analog_references (self)
 
- Public Member Functions inherited from ahio.abstract_driver.AbstractDriver
def available_pins (self)
 Returns available pins. More...
 
def map_pin (self, abstract_pin_id, physical_pin_id)
 Maps a pin number to a physical device pin. More...
 
def mapped_pins (self)
 Returns a dictionary containing the mapped pins. More...
 
def set_pin_interpolation (self, pin, read_min, read_max, write_min, write_max)
 Interpolates input and output values for pin. More...
 
def set_pin_direction (self, pin, direction)
 Sets pin pin to direction. More...
 
def pin_direction (self, pin)
 Gets the ahio.Direction this pin was set to. More...
 
def set_pin_type (self, pin, ptype)
 Sets pin pin to type. More...
 
def pin_type (self, pin)
 Gets the ahio.PortType this pin was set to. More...
 
def write (self, pin, value, pwm=False)
 Sets the output to the given value. More...
 
def read (self, pin)
 Reads value from pin pin. More...
 
def analog_references (self)
 Possible values for analog reference. More...
 
def set_analog_reference (self, reference, pin=None)
 Sets the analog reference to reference More...
 
def analog_reference (self, pin=None)
 Returns the analog reference. More...
 
def set_pwm_frequency (self, frequency, pin=None)
 Sets PWM frequency, if supported by hardware. More...
 

Detailed Description

Definition at line 35 of file generic_tcp_io.py.

Member Function Documentation

§ __enter__()

def ahio.drivers.generic_tcp_io.Driver.__enter__ (   self)

Definition at line 38 of file generic_tcp_io.py.

§ __exit__()

def ahio.drivers.generic_tcp_io.Driver.__exit__ (   self,
  exc_type,
  exc_value,
  traceback 
)

Definition at line 41 of file generic_tcp_io.py.

§ analog_references()

def ahio.drivers.generic_tcp_io.Driver.analog_references (   self)

Definition at line 200 of file generic_tcp_io.py.

§ available_pins()

def ahio.drivers.generic_tcp_io.Driver.available_pins (   self)

Definition at line 70 of file generic_tcp_io.py.

§ setup()

def ahio.drivers.generic_tcp_io.Driver.setup (   self,
  address,
  port 
)

Connects to server at address:port.

Connects to a TCP server listening at address:port that implements the protocol described in the file "Generic TCP I:O Protocol.md"

  • address IP or address to connect to.
  • port port to connect to.
Exceptions
RuntimeErrorif connection was successiful but protocol isn't supported.
anyexception thrown by socket.socket's methods.

Definition at line 59 of file generic_tcp_io.py.


The documentation for this class was generated from the following file: