Add Custom Python Modules

Additional Python modules (py files) can be installed in the user's My Documents\ARC\Python Modules folder.

Using PIP

PIP is a python installer to install python modules. By default, it will install the modules in Windows in a different folder than ARC uses. You can change the PIP install folder by editing the INI file. You will need to specify the default install location within a pip.ini file, which, is usually located as follows...

• On Unix and Mac OS X the configuration file is: $HOME/.pip/pip.conf
• On Windows, the configuration file is: %HOME%\pip\pip.ini

1. The %HOME% is located in C:\Users\Bob on windows assuming your name is Bob. So, it would be C:\Users\\pip\pip.ini

2. You may have to create the pip.ini file when you find your pip directory. Within your pip.ini or pip.config you will then need to put (assuming you're on windows) something like...

   [global]
   target=C:\Users\Bob\My Documents\ARC\Python Modules
   Except that you would replace "C:\Users\Bob\My Documents\ARC\Python Modules" with whatever path contains the Synthiam ARC Python folder in your My Documents.
   
   

Creating an Example Module

Creating a Python module that prints "Hello, World!" is quite straightforward. You can create a Python file with a function that prints the desired message. Here's an example of a simple Python module named hello_world_module.py:

Please navigate to the My Documents\ARC\Python Modules folder and create a hello_world_module.py file. Enter the following code in the file.

# hello_world_module.py

def say_hello():
    print("Hello, World!")
You can save this code in a file with the name hello_world_module.py. To use this module, you can import it into another Python script and call the say_hello function:

Now, add a SCRIPT robot skill to the project. Edit the script, switch to the Python tab, and insert this code.

# add to a python script in ARC

import hello_world_module

hello_world_module.say_hello()

When you run the Python script in ARC, it will import the hello_world_module and execute the say_hello function, which will print "Hello, World!" to the console output.

Example Module - TCP Client

This example module can be placed in the My Documents\ARC\Python Modules folder and named ARCClient.py (case sensitive is required). This example module will connect to the Synthiam ARC TCP Server, which can be enabled in the Connection robot skill. This script can also be added to any Python modules folder to use remotely from another machine. The ARC TCP Server uses EZ-Script so you'll need to reference the manual for ez-script here.

import socket

class ARCClient:
    def __init__(self, server_ip, server_port):
        self.server_ip = server_ip
        self.server_port = server_port
        self.sock = None
        self.version = "unknown"

    def connect(self):
        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        try:
            self.sock.connect((self.server_ip, self.server_port))

            self.version = self._receive_response()
            print("Version:", self.version.decode())

        except Exception as e:
            print("Connection error:", str(e))

    def send_command(self, command):
        if self.sock:
            self.sock.sendall(command.encode())
            response = self._receive_response()
            return response.decode()

    def close(self):
        if self.sock:
            self.sock.close()
            self.sock = None

    def _receive_response(self):
        response = b''
        while True:
            data = self.sock.recv(1024)
            if not data:
                break
            response += data
            if b'\n' in data:
                break
        return response

    def version(self):
        return self.version
        
if __name__ == "__main__":
    server_ip = '127.0.0.1'
    server_port = 6666
    command = "SayEZB(\"I am connected\")\n"

    arc_client = ARCClient(server_ip, server_port)
    arc_client.connect()
    response = arc_client.send_command(command)
    print("Received response:", response)
    arc_client.close()

To use this module, add a Script robot skill to your project and place the following code...

from ARCClient import ARCClient

server_ip = '127.0.0.1'
server_port = 6666
command = "SayEZB(\"I am connected\")\n"

arc_client = ARCClient(server_ip, server_port)
arc_client.connect()
response = arc_client.send_command(command)
print("Received response:", response)
arc_client.close()

The TCP Server will also need to be enabled in the Connection robot skill.