Using Interactive Mode Programmatically

Mechanism of Interactive Mode

In its initial state, the RX port of TWELITE operates at 115200bps 8N1. To transition into interactive mode, input + three times at intervals of approximately 200 to 1000ms, or for some applications, pull the SET pin low during startup. Since interactive mode accepts only ASCII characters as input, it can be freely controlled programmatically.

Implementation Example

Reading Configuration Values Using Python for Serial Communication App

Below is a script that reads the serial ID and configuration values from a TWELITE device programmed with the serial communication app App_Uart, via TWELITE R2/R3.

pip install tweliter

Script

Using Python 3.12.

For the serial communication app specifications, we enter interactive mode by inputting + three times here.

# -*- coding: utf-8 -*-

import time
import re

from tweliter import Tweliter  # Mono Wireless module for TWELITE R devices


def get_serial_id_and_settings() -> tuple[str, dict[str, str]] | None:
    """
    Get the serial ID and settings from the interactive mode of a TWELITE R device.

    Returns:
        tuple[str, dict[str, str]] | None:
            A tuple containing:
            - str: the serial ID (e.g., "0x82010079")
            - dict[str, str]: the settings dictionary (e.g., {'a': '0x67720103', ...})
            Returns None if the device cannot be accessed or the output is invalid.

    Notes:
        Example output from the interactive mode of an App_Uart device:
        --- CONFIG/TWE UART APP V1-04-6/SID=0x82010079/LID=0x78 -- ---
         a: set Application ID (0x67720103)
         i: set Device ID (120=0x78)
         c: set Channels (18)
         x: set RF Conf (3)
         r: set Role (0x0)
         l: set Layer (0x1)
         b: set UART baud (38400)
         B: set UART option (8N1)
         m: set UART mode (E)
         k: set Tx Trigger (sep=0x0d0a, min_bytes=0 dly=0[ms])
         h: set header format [;U;%t;%i;0x%A;%q;%s;<*;%X;\n]
         C: set crypt mode (0)
         o: set option bits (0x00000100)
        ---
         S: save Configuration
         R: reset to Defaults
    """
    try:
        with Tweliter(
            type_filter=Tweliter.Type.TWELITE_R2 | Tweliter.Type.TWELITE_R3
        ) as liter:
            # Reset the device
            liter.reset_device()

            # Get the serial port instance (pyserial)
            ser = liter.get_serial_instance()
            ser.timeout = 1.0

            # Enter to the interactive mode
            for _ in range(3):
                ser.write("+")
                time.sleep(0.3)

            # Read the output
            raw_output = ser.read_until(b"S:").decode("utf-8")

            # Reset the device (Exit interactive mode)
            liter.reset_device()
    except IOError as e:
        print(f"Couldn't open the device {e}")
        return None

    # Find the settings block in the output
    filter_output = re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL)
    if filter_output:
        information_line = filter_output.group(1)
        settings_block = filter_output.group(2)
    else:
        print("No settings block found.")
        return None

    # Extract serial id from the information line
    serial_id_match = re.search(r"SID=0x([0-9A-Fa-f]+)", information_line)
    if serial_id_match:
        serial_id = f"0x{serial_id_match.group(1)}"
    else:
        print("Serial ID not found.")
        return None

    # Extract key-value pairs (str,str) from the settings block
    settings_dict = dict(
        re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE)
    )

    return serial_id, settings_dict


def main() -> None:
    # Get the serial ID and settings from the device
    result = get_serial_id_and_settings()
    if result is None:
        print("Failed to retrieve serial ID and settings.")
        return
    serial_id, settings = result

    # Show the results
    print(f"Serial ID: {serial_id}")
    for id, value in settings.items():
        match id:
            case "a":
                print(f"Application ID: {value}")
            # case "i":
            #     print(f"Logical ID: {value}")
            # case "c":
            #     print(f"Channel: {value}")


if __name__ == "__main__":
    main()

Explanation

Flow of Reading Output from Interactive Mode

1. Reset the TWELITE
   • Resetting brings the device back to its initial state for entering interactive mode. This reset is performed by controlling the reset pin on TWELITE R2/R3.
2. Obtain the serial port instance
   • Using pyserial, obtain an instance for accessing serial I/O of TWELITE from the PC. Through this instance, you can send commands and read data.
3. Input + three times
   • By sending + three times at fixed intervals (200–1000ms), TWELITE transitions into interactive mode. This method is the same as manual operation by the user.
4. Read output up to the line starting with S:
   • In interactive mode, the line S: appears after a series of configuration items. Reading up to this point ensures that all configuration contents are retrieved.
5. Reset the TWELITE
   • After reading, reset again to return from interactive mode to normal operation.

with Tweliter(
    type_filter=Tweliter.Type.TWELITE_R2 | Tweliter.Type.TWELITE_R3
) as liter:
    # Reset the device
    liter.reset_device()

    # Get the serial port instance (pyserial)
    ser = liter.get_serial_instance()
    ser.timeout = 1.0

    # Enter to the interactive mode
    for _ in range(3):
        ser.write("+")
        time.sleep(0.3)

    # Read the output
    raw_output = ser.read_until(b"S:").decode("utf-8")

    # Reset the device (Exit interactive mode)
    liter.reset_device()

Flow of Interpreting Output from Interactive Mode

1. Extract the line and the block enclosed by ---
   • Use re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL) to retrieve the full configuration info from the interactive mode output, divided into two parts: information_line (containing serial ID etc.), and settings_block (listing configuration items). re.DOTALL enables matching across multiple lines.
2. Extract the serial ID from the first line
   • Use re.search(r"SID=0x([0-9A-Fa-f]+)", information_line) to obtain the hexadecimal ID following SID=0x, format it as a string like 0x82010079. Both uppercase and lowercase hex digits are matched.
3. Extract command ID and value pairs from the block
   • Use re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE) to extract lines in the format like a: ... (value), retrieving the one-letter command ID and the value inside parentheses. Leading spaces and any characters after the colon are ignored. re.MULTILINE enables matching across multiple lines.

# Find the settings block in the output
filter_output = re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL)
if filter_output:
    information_line = filter_output.group(1)
    settings_block = filter_output.group(2)
else:
    print("No settings block found.")
    return None

# Extract serial id from the information line
serial_id_match = re.search(r"SID=0x([0-9A-Fa-f]+)", information_line)
if serial_id_match:
    serial_id = f"0x{serial_id_match.group(1)}"
else:
    print("Serial ID not found.")
    return None

# Extract key-value pairs (str,str) from the settings block
settings_dict = dict(
    re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE)
)

return serial_id, settings_dict

Reading Configuration Values and Changing Logical Device ID Using Python for Cue App

Here, we introduce a script that reads the serial ID and configuration values from a TWELITE device programmed with the Cue app App_Cue, via TWELITE R2/R3, and updates the logical device ID.

pip install tweliter

Script

Using Python 3.12.

For the Cue app specifications, we enter interactive mode by pulling the SET pin low here.

def enter_interactive_mode_manually(liter: Tweliter) -> None:
    liter.reset_device()
    ser = liter.get_serial_instance()
    for _ in range(3):
        ser.write("+")
        time.sleep(0.3)

# -*- coding: utf-8 -*-

import time
import re

from tweliter import Tweliter  # Mono Wireless module for TWELITE R devices


def revert_all_setttings(liter: Tweliter) -> None:
    """
    Revert all settings

    Args:
        liter (Tweliter): Tweliter instance
    """
    # Get the serial port instance (pyserial)
    ser = liter.get_serial_instance()
    ser.timeout = 1.0

    # Set logical id
    ser.write("R")
    time.sleep(0.3)
    ser.write("S")


def get_serial_id_and_settings(liter: Tweliter) -> tuple[str, dict[str, str]] | None:
    """
    Get the serial ID and all settings

    Args:
        liter (Tweliter): Tweliter instance

    Returns:
        tuple[str, dict[str, str]] | None:
            A tuple containing:
            - str: the serial ID (e.g., "82010079")
            - dict[str, str]: the settings dictionary (e.g., {'a': '0x67720103', ...})
            Returns None if the device cannot be accessed or the output is invalid.
    """
    # Get the serial port instance (pyserial)
    ser = liter.get_serial_instance()
    ser.timeout = 1.0

    # Read the output
    raw_output = ser.read_until(b"S:").decode("utf-8")

    # Find the settings block in the output
    filter_output = re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL)
    if filter_output:
        information_line = filter_output.group(1)
        settings_block = filter_output.group(2)
    else:
        print("No settings block found.")
        return None

    # Extract serial id from the information line
    serial_id_match = re.search(r"SID=0x([0-9A-Fa-f]+)", information_line)
    if serial_id_match:
        serial_id = f"0x{serial_id_match.group(1)}"
    else:
        print("Serial ID not found.")
        return None

    # Extract key-value pairs (str,str) from the settings block
    settings_dict = dict(
        re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE)
    )

    return serial_id, settings_dict


def set_logical_id(liter: Tweliter, lid: int) -> None:
    """
    Set new logical id and save it

    Args:
        liter (Tweliter): Tweliter instance
        lid (int): New logical id
    """
    # Get the serial port instance (pyserial)
    ser = liter.get_serial_instance()
    ser.timeout = 1.0

    # Set logical id
    ser.write("i")
    time.sleep(0.3)
    ser.write(f"{lid}\r\n")
    time.sleep(0.3)
    ser.write("S")


def print_settings(settings: dict[str, str], select: list[str] | None = None) -> None:
    """
    Print settings

    Args:
        settings (dict[str, str]): Settings dict
        select (list[str] | None): List of IDs for selected entries. None to select all
    """
    for id, value in settings.items():
        if select is None or id in select:
            match id:
                case "a":
                    print(f"Application ID: {value}")
                case "i":
                    print(f"Logical ID: {value}")
                case "c":
                    print(f"Channel: {value}")
                case "x":
                    print(f"Power / Retry: {value}")
                case "b":
                    print(f"UART Baudrate: {value}")
                case "B":
                    print(f"UART Options: {value}")
                case "k":
                    print(f"Encryption Key: {value}")
                case "o":
                    print(f"Option Bits: {value}")
                case "t":
                    print(f"Transmission Interval: {value}")
                case "p":
                    print(f"Sensor Parameters: {value}")
                case _:
                    print(f"{id}: {value}")


def main() -> None:
    """
    Main function
    """
    lid_to_set = 25
    try:
        with Tweliter(
            type_filter=Tweliter.Type.TWELITE_R2 | Tweliter.Type.TWELITE_R3
        ) as liter:
            # Revert all settings
            print("\nReverting to default settings...")
            liter.enter_interactive_mode()
            revert_all_setttings(liter)

            # Get the serial ID and settings from the device
            liter.enter_interactive_mode()
            result = get_serial_id_and_settings(liter)
            if result is None:
                print("Failed to get serial ID and settings.")
                return
            serial_id, settings = result
            print(f"\nCurrent settings for the device {serial_id}:")
            print_settings(settings)

            # Set logical ID
            print(
                f"\nModifying Logical ID {settings["i"]} to {lid_to_set}=0x{lid_to_set:02x}..."
            )
            set_logical_id(liter, lid_to_set)

            # Get updated setttings
            liter.enter_interactive_mode()
            result = get_serial_id_and_settings(liter)
            if result is None:
                print("Failed to get serial ID and settings.")
                return
            serial_id, settings = result
            print(f"\nUpdated setting(s) for the device {serial_id}:")
            print_settings(settings, select=["i"])

            # Reset the device (Exit interactive mode)
            liter.reset_device()

    except IOError as e:
        print(f"Couldn't open the device {e}")
        return None


if __name__ == "__main__":
    main()

When you run the script, it changes the logical device ID to 25 as shown in the following example:

python modify_app_cue_settings.py
Using TWE-Lite-R R27BESFJ @ ftdi://::R27BESFJ/1

Reverting to default settings...

Current settings for the device 0x8201872b:
Application ID: 0x67720102
Logical ID: --
Channel: 18
Power / Retry: 13
UART Baudrate: 38400
UART Options: 8N1
Encryption Key: 0xA5A5A5A5
Option Bits: 0x00000001
Transmission Interval: 5
Sensor Parameters: 0x00000000

Modifying Logical ID -- to 25=0x19...

Updated setting(s) for the device 0x8201872b:
Logical ID: 25=0x19

Explanation

Process for Reading Configuration Values

1. Get the serial port instance
   • Use get_serial_instance() to obtain the serial port instance.
2. Read the string from the serial port up to S: which contains the save command description
   • In interactive mode, after the configuration values are displayed, the save command description S: appears. By reading up to this point, you can retrieve all configuration content.
3. Extract the first line and the block enclosed by ---
   • Use re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL) to extract the interactive mode output into two parts: the first capture group is the information line (information_line) containing the serial ID, and the next group is the settings block (settings_block) containing the configuration items. re.DOTALL enables full-text search including newlines.
4. Extract the serial ID from the first line
   • Use re.search(r"SID=0x([0-9A-Fa-f]+)", information_line) to retrieve the hexadecimal ID value following SID=0x (e.g., 82010079) and format it as a string like 0x82010079. Hexadecimal digits are extracted regardless of case.
5. Extract command ID and value pairs from the block
   • Use re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE) to extract the command ID (single character) and the value within parentheses from lines in the format a: ... (value). Leading spaces and any characters after the colon are skipped, extracting only the first parenthesized value found. re.MULTILINE enables matching across multiple lines.

    # Get the serial port instance (pyserial)
    ser = liter.get_serial_instance()
    ser.timeout = 1.0

    # Read the output
    raw_output = ser.read_until(b"S:").decode("utf-8")

    # Find the settings block in the output
    filter_output = re.search(r"---(.*?)---(.*?)---", raw_output, re.DOTALL)
    if filter_output:
        information_line = filter_output.group(1)
        settings_block = filter_output.group(2)
    else:
        print("No settings block found.")
        return None

    # Extract serial id from the information line
    serial_id_match = re.search(r"SID=0x([0-9A-Fa-f]+)", information_line)
    if serial_id_match:
        serial_id = f"0x{serial_id_match.group(1)}"
    else:
        print("Serial ID not found.")
        return None

    # Extract key-value pairs (str,str) from the settings block
    settings_dict = dict(
        re.findall(r"^\s*(\w):.*?\(([^()]*)\)", settings_block, re.MULTILINE)
    )

    return serial_id, settings_dict