Skip to content

ingics/igs03-batch-config

Repository files navigation

iGS03 Batch Configuration Tools

Tools for batch configuring Ingics iGS03 gateways via SSH (default) or Telnet.

Setup

  1. Install required packages:
    pip install -r requirements.txt
  2. Create and activate a virtual environment (recommended):
    python -m venv .venv
    .\.venv\Scripts\activate  # Windows
    source .venv/bin/activate  # Linux/macOS

Tools

1. Batch Configurator (batch-config.py)

This is the main script for batch configuring iGS03 devices that already have network settings and are accessible on your network.

Usage:

python batch-config.py <IP1> [IP2] ... [OPTIONS]

Example:

python batch-config.py 192.168.1.108 192.168.1.128 --username admin --password admin

2. iGS03E mDNS Configurator (igs03e-batch-config-by-mdns.py)

A specialized version for iGS03E devices. It uses mDNS to automatically discover iGS03E devices on the local network and apply configuration as they appear.

Important

CAUTION: This script will automatically apply configuration settings to ALL iGS03E devices it discovers on the local network. Use with care.

Usage:

python igs03e-batch-config-by-mdns.py [OPTIONS]

Protocol Auto-Detection: This tool automatically selects the connection protocol based on the device firmware version (V3.0.0+ uses SSH, otherwise Telnet). No manual protocol selection is required.

Initial Configuration for New Devices

For new iGS03W/iGS03M/iGS03MP devices, you can follow these steps for initial setup:

  1. Modify batch-config.py for your specified configurations (Customizing Commands)
  2. Power on the iGS03W/M/MP device.
  3. Connect to the iGS03 device's WiFi AP manually.
  4. Run the batch configurator with the default AP gateway address:
    python batch-config.py --set-password iampassword 192.168.10.1
  5. Repeat steps 2-4 for each additional device.

Important

CAUTION: For security reason, change default password is required to enable iGS03 data publish functionality. Use --set-password to change the password for each device.

Customizing Commands

Both scripts are designed to be updated manually for your specific requirements. You must modify the desired commands in the source code.

For example, in batch-config.py:

# modify these lines for your own settings
client.exec('MQTT CLIENTID', f'{model}_{identity}')
client.exec('MQTT PUBTOPIC', f'GNS_{identity}')
client.exec('BLE PAYLOADWD 1', 'XXFFXX008XBC')

Avaiable commands can be found in iGS03 Series Telnet Command.

Options

  • --telnet: Use Telnet protocol (SSH is the default).
  • --username: Custom login username (default: admin).
  • --password: Custom login password (default: admin).
  • --set-password: Change login password

Notice

The scripts support SSH and Telnet. SSH is used for V3.0.0 and above firmware, and Telnet is used for legacy firmware. These tools require Python 3.8+.

About

Example of iGS03 batch configuration

Topics

Resources

License

Stars

1 star

Watchers

2 watching

Forks

Contributors

Languages