ATtila

~ Communicate easily with modems and RF modules using AT commands ~

Developed by @veeso

Current version: 1.2.3 (23/09/2022)

ATtila

pip3 install attila

About ATtila 📢

ATtila is both a Python3 🐍 module and a CLI utility. The module's purpose is to ease the communication with devices through serial port, automating the scripts execution workflow; in particular ATtila is designed for RF modules which use AT commands.

It is both possible to send single AT commands indicating what is the expected response, what information to store for each command and define an alternative behaviour in case of an unexpected responses.
These are the main functionalities that ATtila provides:

Façade to communicate with the serial devices
Sending AT commands and define the expected response for it
Collect values from response and store them in the session storage
Define a command to execute in case the previously executed command fails
Sending individual AT command to RF module/modem through serial port and get the response

ATtila comes, as said before, with a binary (which can be used instead of the classic chat binary) to pair with pppd, or for anything you want. You can run ATtila binary with

python3 -m attila
#Or if installed, just
attila

Usage: attila [OPTION]... [FILE]

  With no FILE, run in interactive mode

  -p  <device path>     Use this device to communicate
  -b  <baud rate>       Use the specified baudrate to communicate
  -T  <default timeout> Use the specified timeout as default to communicate
  -B  <break>           Use the specified line break [CRLF, LF, CR, NONE] (Default: CRLF)
  -A  <True/False>      Abort on failure (Default: True)
  -L  <logfile>         Enable log and log to the specified log file (stdout is supported)
  -l  <loglevel>        Specify the log level (0: CRITICAL, 1: ERROR, 2: WARN, 3: INFO, 4: DEBUG) (Default: INFO)
  -v                    Be more verbose
  -q                    Be quiet (print only PRINT ESKs and ERRORS)
  -h                    Show this page

Requirements 🛒

Python3.5 (>= 1.2.0)
- Python3.4 (up to 1.1.x - switch to 1.1.x branch)
pyserial3

Get Started 🛠

In order to build your own implementation using ATtila these are the steps you need to follow:

Import the AT Runtime Environment into your project

The first thing you have to do is to import the AT Runtime Environment and the exceptions it can raise in your project

from attila.atre import ATRuntimeEnvironment
from attila.exceptions import ATREUninitializedError, ATRuntimeError, ATScriptNotFound, ATScriptSyntaxError, ATSerialPortError

Instantiate an ATRuntimeEnvironment object

atrunenv = ATRuntimeEnvironment(abort_on_failure)

Configure the communicator

This is the component which will communicate with your device
```
atrunenv.configure_communicator(device, baud_rate, default_timeout, line_break)
```
Open the serial port

Be careful, this function can return an ATSerialPortError
```
atrunenv.open_serial()
```
Choose how to parse commands:
1. Parse an ATScript
  
  parse_ATScript can raise ATScriptNotFound or ATScriptSyntaxError
```
atrunenv.parse_ATScript(script_file)
```
2. Execute directly a command (or an ESK)
```
response = atrunenv.exec(command_str)
```
3. Add an ATCommand to the session
```
atrunenv.add_command(command_str)
```
Execute commands:
1. Run everything at once and then get a list of ATResponse
  
  if abort_on_failure is True, the ATRE will raise ATRuntimeError during execution
```
response_list = atrunenv.run()
```
2. Run one command a time (if abort_on_failure is True, the ATRE will raise ATRuntimeError):
```
response = atrunenv.exec_next()
```

Collect the values you need

rssi = atrunenv.get_session_value("rssi")

Close serial
```
atrunenv.close_serial()
```

Virtual Device ⌨

Since version 1.1.0, it is possible to use a virtual serial device, instead of a real one. This has been introduced for test purposes, but can actually be used in case you need to emulate a serial device and you want to keep using ATtila. In this case, in the ATRE, instead of using configure_communicator use:

def configure_virtual_communicator(self, serial_port, baud_rate, timeout = None, line_break = "\r\n", read_callback = None, write_callback = None, in_waiting_callback = None)

The virtual communicator, in addition to the standard one, requires a read, a write and an in_waiting callback. These callbacks must replace the I/O operations of the serial device, with something else (e.g. a socket with an HTTP request)

ATScripts 💻

ATtila uses its own syntax to communicate with the serial device, which is called ATScript (ATS). The basic syntax for it, is:

COMMAND;;RESPONSE_EXPR;;DELAY;;TIMEOUT;;["COLLECTABLE1",...];;DOPPELGANGER;;DOPPELGANGER_RESPONSE

To know more about ATS see the ATScript documentation

Support the developer ☕

If you like ATtila and you're grateful for the work I've done, please consider a little donation 🥳

You can make a donation on the following platforms:

Contributions 🤝🏻

Contributions are welcome! 😉

If you think you can contribute to ATtila, please follow ATtila's Contributions Guidelines

Changelog 🕑

View Changelog HERE

Branches 🌳

master: stable only with latest features
1.1.x: LTS with Python3.4 support; this version will receive only patch for major issues
dev: main development branch
other features

License 📜

View LICENSE HERE

veeso / ATtila

readme