This file contains the details about the script 'connman.py' and the instructions to use it.

The file defines the classes TConnection and SConnection that can be imported as:

from connman import TConnection
from connman import SConnection

The file connman.py will have to be in the same directory as the script that imports the classes.

TConnection

An object of type TConnection can be then defined as follows:

1. Without any arguments

C = TConnection()

2. Host ip as the only argument

C = TConnection("ip")

3. Host ip and port as arguments:

C = TConnection("ip", port)

The following fields have a default value associated with them and are utilized when no argument is supplied to the constructor.

• ip: 172.24.0.75
• port: 23

Note: The ip will have to be a string whereas the port will have to be an integer.

The object of type TConnection will have the following functions available to it:

1. send(cmd)
2. justSend(cmd)
3. setup()
4. status(rsp)
5. powerOffPort(port)
6. powerOnPort(port)
7. togglePort(port)
8. refresh()
9. cyclePower(port, t)
10. On1()
11. On2()
12. On3()
13. On4()
14. On5()
15. On6()
16. On7()
17. On8()
18. Off1()
19. Off2()
20. Off3()
21. Off4()
22. Off5()
23. Off6()
24. Off7()
25. Off8()

A brief description of these functions is available below.

1. send(cmd):- This function will send the contents of the variable cmd as a string over Telnet to the connected host. Note that the command does not have to be a string. The function justSend(cmd) is functionally the same thing as send(cmd), except that it does not monitor the PSU output to analyze which ports are on and which are off.

2. setup():- This function will take the PSU in the mode from which the ports can be controlled. This function is designed for internal use rather than being called on an object.

3. status(rsp):- This function takes the PSU output as its input and analyses which ports are on and off. This function is designed for internal use rather than being called on an object.

4. powerOffPort(port):- This function takes an integer between 0 and 8, inclusive, as input. For an input between 1 and 8, the function, as aptly named, will power the port off. If 0 is supplied, then all of the ports from 1 to 8 will be turned off.

5. powerOnPort(port):- This function takes an integer between 0 and 8, inclusive, as input. For an input between 1 and 8, the function, as aptly named, will power the port on. If 0 is supplied, then all of the ports from 1 to 8 will be turned on.

6. togglePort(port):- This function takes an integer between 1 and 8, inclusive, as input. For an input between 1 and 8, the function, as aptly named, will toggle the port.

7. refresh():- This function will restablish the telnet connection with the PSU if more than 120 seconds have passed since the last interaction. Essentialy, it revives a timed out connection.

8. cyclePower(port, t):- This function will toggle the supplied port, wait for t seconds, and then toggle the port again.

The functions from 9 to 24 behave exactly as their name would suggest. The ony thing to note is that calling on on a port that is already on will not turn the port off and vice versa.

SConnection

An object of type SConnection can be then defined as follows:

1. Serial device as the only argument:

C = TConnection("device")

2. Serial device and baudrate as arguments:

C = TConnection("device", baudrate)

3. Serial device, baudrate, and timeout, in seconds, as arguments:

C = TConnection("device", baudrate, timeout)

The following fields have a default value associated with them and are utilized when a value for the argument is not supplied to the constructor.

• baudrate: 115200
• timeout: 1

Note: The device will have to be a string, the baudrate will have to be an integer and timeout can be either float, double or integer.

The object of type SConnection will have the following functions available to it:

1. send(cmd)
2. readAll()

A brief description of these functions is available below.

1. send(cmd):- This method will append a '\r' at the end of the command supplied and write that to the provided serial device. Making the process of writing commands over the serial connection easier is the main focus of this function. The command doesn't have to be a string. The method will return the result of sending the specified command to the device as a string.

2. readAll():- If there are things in the serial communication buffer, this method will return them all as a single variable. The send(cmd) method utilizes this method internally.