Skip to content

usage.md

Latest commit

 

History

History
155 lines (114 loc) · 3.09 KB

usage.md

File metadata and controls

155 lines (114 loc) · 3.09 KB

Usage Guide

Basic Usage

circremote <device> <command> [options]

Device Connections

Serial Connections

macOS/Linux:

# USB-to-serial adapter
circremote /dev/ttyUSB0 BME280

# Arduino-style device
circremote /dev/ttyACM0 scan-i2c

# Built-in serial port
circremote /dev/ttyS0 system-info

Windows:

# Standard COM ports
circremote COM3 BME280
circremote COM1 scan-i2c
circremote COM2 system-info

Web Workflow Connections

# Default port (80)
circremote 192.168.1.100 BME280

# Custom port
circremote 192.168.1.100:8080 BME280

# With password
circremote -p mypassword 192.168.1.100 BME280

Commands

Built-in Commands

# List files on device
circremote /dev/ttyUSB0 ls /

# Remove files
circremote /dev/ttyUSB0 rm old_file.py

# Scan I2C bus
circremote /dev/ttyUSB0 scan-i2c

# System information
circremote /dev/ttyUSB0 system-info

Remote Commands

# From GitHub repository
circremote /dev/ttyUSB0 https://github.com/user/repo/tree/main/commands/BME280

# From web server
circremote /dev/ttyUSB0 https://example.com/sensor_demo.py

# From local file
circremote /dev/ttyUSB0 /path/to/my/command.py

Getting Help

General Help

# Show general help and options
circremote -h

# List all available commands
circremote -l

Command-Specific Help

# Show detailed help for a specific command
circremote -h BME280

# Help shows command status (tested/not tested)
circremote -h VCNL4040

The command help includes:

  • Description: What the command does
  • Status: Whether the command has been tested (✅ Tested, ⚠️ Not tested, ❓ Unknown)
  • Arguments: Required and optional parameters with defaults
  • Examples: Usage examples with different parameter combinations

Options

  • -v, --verbose: Verbose debug output
  • -q, --quiet: Quiet mode (suppress output except device output)
  • -y, --yes: Auto-confirm all prompts
  • -c, --skip-circup: Skip dependency installation
  • -p, --password: Web Workflow password
  • -C, --config: Custom config file path
  • -u, --circup: Custom circup path
  • -t, --timeout: Connection timeout (seconds)
  • -h, --help: Show help (general or command-specific)
  • -l, --list: List all available commands

Examples

Basic Sensor Reading

# Temperature and humidity
circremote /dev/ttyUSB0 BME280

# With verbose output
circremote -v /dev/ttyUSB0 BME280

# Using device defaults (no need to specify I2C pins)
circremote my-device BME280

# Using global variable defaults (configured in config.json)
circremote /dev/ttyUSB0 BME280  # Uses global sda/scl defaults

File Operations

# List all files
circremote /dev/ttyUSB0 ls /

# List specific directory
circremote /dev/ttyUSB0 ls /lib

# Remove file
circremote /dev/ttyUSB0 rm old_data.txt

Web Workflow Setup

# Configure Web Workflow on ESP32 device
circremote /dev/ttyUSB0 enable-webworkflow "MyWiFiNetwork" "mypassword" 8080 "webpass"

# After configuration, use Web Workflow connection
circremote 192.168.1.100:8080 -p webpass BME280

Remote Code Execution