split out install and usage

more doc improvements

Author: romkey

README.md

@@ -12,241 +12,17 @@ It can also pull code from a web server, so you can run Adafruit example code di
 
 It supports a search path for code locations, so you can define your own or use other people's libraries, and fall back to the ones bundled with circremote.
 
-One thing it currently does not do is support Microsoft Windows. I do not have a Windows machine and have no way to test it with Windows. I understand that a lot of people use Windows and that the lack of support means that a lot of people who might benefit from circremote won't be able to use it. While I'm happy to spend some time and resources on continuing to develop circremote and support users, I don't have the time, energy or desire to bring up a new platform and get it working on it. If a motivated co-maintainer comes along who'd like to get circremote working properly with Windows and then support it, I'd be happy to bring someone like that onto the project.
+circremote does not support Microsoft Windows. I do not have a Windows machine and have no way to test it with Windows. I understand that a lot of people use Windows and that the lack of support means that a lot of people who might benefit from circremote won't be able to use it. While I'm happy to spend some time and resources on continuing to develop circremote and support users, I don't have the time, energy or desire to bring up a new platform and get it working on it. If a motivated co-maintainer comes along who'd like to get circremote working properly with Windows and then support it, I'd be happy to bring someone like that onto the project.
 
 From here, see how to install circremote and then please check out the [FAQ](doc/FAQ.md) to see how to use it.
 
 - [About circremote](doc/about.md)
+- [Install](doc/install.md)
+- [Usage](doc/usage.md)
 - [Commands](doc/commands.md)
 - [Configuration](doc/configuration.md)
 - [Contributing](doc/contributing.md)
 
-## Installation
-
-### ~~From PyPI~~
-
-(Not yet listed on PyPl so try "From Github" instead)
-
-```bash
-pip install circremote
-```
-
-### From Github
-```
-pip install git+https://github.com/romkey/circremote
-```
-
-### From Source
-
-```bash
-git clone https://github.com/romkey/circremote
-cd circremote-python
-pip install -e .
-```
-
-### Using Docker
-
-**Note: running circup is not currently working correctly in the Docker image**
-
-```bash
-# Build the Docker image (includes circup for dependency management)
-docker build -f docker/Dockerfile -t circremote:latest .
-
-# Run circremote in a container with a serial port
-CIRCREMOTE_SERIAL=/dev/ttyUSB0 docker-compose -f docker/docker-compose.yml run circremote-serial /dev/ttyUSB0 BME280
-
-# Run circremote in a container with a networked device
-docker-compose -f docker/docker-compose.yml run circremote 192.168.1.100 -p PASSWORD  BME280
-
-# Test circup installation
-docker run --rm circremote:latest circup --version
-
-# For more Docker options, see [docker/README.md](docker/README.md)
-```
-
-## Usage
-
-### Basic Usage
-
-```bash
-circremote [options] <serial_port or ip:port> <command_name> [command line options]
-```
-
-### Show Version
-```bash
-circremote --version
-# or
-circremote -V
-```
-
-### Examples
-
-#### Serial Connection
-```bash
-# Run BME280 sensor code on serial port
-circremote /dev/ttyUSB0 BME280
-
-# Run with verbose output
-circremote -v /dev/ttyACM0 VL53L1X
-
-# Run with double exit (additional Ctrl+D)
-circremote -d /dev/ttyUSB0 system-info
-```
-
-#### WebSocket Connection (CircuitPython Web Workflow)
-```bash
-# Connect to CircuitPython device via IP
-circremote 192.168.1.100 SHT30
-
-# Connect with custom port
-circremote 192.168.1.100:8080 show-settings
-
-# Connect with HTTP basic auth password
-circremote -p mypassword 192.168.1.100 scan-i2c
-
-# Combine options
-circremote -v -d -p mypassword 192.168.1.100:8080 BME680
-
-# Skip dependency installation
-circremote -c /dev/ttyUSB0 BME280
-
-# Specify custom circup path
-circremote -u /usr/local/bin/circup /dev/ttyUSB0 BME280
-```
-## Options
-
-- `-v, --verbose`: Enable verbose debug output
-- `-p, --password PASSWORD`: HTTP basic auth password for WebSocket connections
-- `-d, --double-exit`: Send additional Ctrl+D after Ctrl+B to exit raw REPL
-- `-y, --yes`: Skip confirmation prompts (run untested commands without asking)
-- `-c, --skip-circup`: Skip circup dependency installation
-- `-u, --circup PATH`: Path to circup executable
-- `-C, --config PATH`: Path to circremote.json config file
-- `-l, --list`: List all available commands from all sources
-- `-h, --help`: Show help message
-- `-h COMMAND`: Show help for a specific command
-- `-V, --version`: Show version and exit
-
-## Features
-
-### Automatic Dependency Management
-When a command has a `requirements.txt` file, circremote can automatically install CircuitPython libraries using `circup`:
-
-- Detects if `circup` is available
-- Prompts user to install dependencies
-- Supports both serial and WebSocket connections for dependency installation
-- Provides options to run, skip, or exit
-
-### Safety Warnings
-Commands can include safety warnings for potentially problematic code:
-
-- Warns about modules that may make devices unreachable
-- Explains potential risks (deep sleep, network disconnection, etc.)
-- Requires user confirmation before proceeding
-
-### Untested Module Warnings
-Commands can be marked as untested:
-
-- Warns about modules that haven't been tested
-- Explains potential issues (wrong pins, addresses, etc.)
-- Requires user confirmation unless `-y` flag is used
-
-### Connection Types
-
-circremote needs a way to communicate with the CircuitPython device that's going to run the code.
-
-#### Serial Connection
-- Supports standard serial ports (USB, UART)
-- Configurable baud rate (default: 115200)
-- Cross-platform support
-
-#### WebSocket Connection
-- Supports CircuitPython Web Workflow
-- HTTP basic authentication
-- Automatic protocol detection (ws/wss)
-- Configurable host and port
-
-### Custom Commands
-You can create your own commands in several ways:
-
-#### Python File Directly
-Create a Python file and run it directly:
-```bash
-circremote /dev/ttyUSB0 ./my_sensor.py
-```
-Running directly will not allow you to use variables, define a command line or have libraries automatically installed.
-
-#### Command Directory Structure
-Create a directory with the required files:
-```
-my_command/
-├── code.py          # Required: Your Python code
-├── info.json        # Optional: Command metadata and variables
-└── requirements.txt # Optional: Dependencies
-```
-
-Then run it:
-```bash
-circremote /dev/ttyUSB0 ./my_command
-```
-
-#### Using Search Paths
-Add custom command directories to your config (see Configuration section above).
-
-### Web Commands
-Run commands directly from URLs:
-```bash
-# GitHub URLs (automatically converted to raw content)
-circremote /dev/ttyUSB0 https://github.com/user/repo/blob/main/sensor.py
-
-# Direct URLs
-circremote /dev/ttyUSB0 https://example.com/sensor.py
-```
-
-### Error Handling
-- Comprehensive error reporting
-- Graceful handling of connection failures
-- Detailed debug output with verbose mode
-- Automatic cleanup of connections
-
-## Getting Help
-
-### General Help
-```bash
-circremote --help
-```
-
-### List All Commands
-```bash
-circremote -l
-```
-
-This shows all available commands from:
-- Built-in commands
-- Search path commands  
-- User commands directory
-- Command aliases (if configured)
-
-### Command-Specific Help
-```bash
-# Show detailed help for any command
-circremote -h BME280
-circremote -h clean
-circremote -h ./my_custom_command
-
-# Shows:
-# - Command description and location
-# - Command line format
-# - All arguments (required/optional)
-# - Default values
-# - Usage examples
-```
-
-### Debug Information
-```bash
-circremote -v /dev/ttyUSB0 BME280
-```
-
 ## Development
 
 ### Installing Locally

doc/commands.md

@@ -3,47 +3,108 @@
 The tool comes with a collection of pre-built sensor and utility commands:
 
 ### Temperature & Humidity Sensors
+- `ADT7410` - High-accuracy digital temperature sensor with ±0.5°C accuracy
 - `AHT20` - Temperature and humidity sensor 
 - `BME280` - Temperature, humidity, and pressure sensor
 - `BME680` - Temperature, humidity, pressure, and gas sensor
+- `DS18B20` - Digital temperature sensor using OneWire protocol
 - `HDC3022` - High-accuracy temperature and humidity sensor 
+- `HTU31` - Digital temperature and humidity sensor with ±0.2°C accuracy
+- `SHT20` - Digital temperature and humidity sensor
 - `SHT30` - High-accuracy temperature and humidity sensor
 - `SHT31D` - Digital temperature and humidity sensor
+- `SHT41` - High-precision digital temperature and humidity sensor
+- `SHT45` - High-precision digital temperature and humidity sensor
+- `SHTC3` - Digital temperature and humidity sensor with 16-bit resolution
+- `Si7021` - Digital temperature and humidity sensor
+- `TMP117` - High-accuracy digital temperature sensor
 
 ### Light Sensors
+- `APDS9960` - Digital proximity, ambient light, RGB color, and gesture sensor
+- `AS7341` - Multi-spectral color sensor
 - `BH1750` - Digital light sensor 
+- `LTR-303` - Digital light sensor
+- `LTR-329` - Digital light sensor
 - `LTR390` - UV light sensor 
+- `TCRT1000` - Reflective optical sensor
 - `TSL2591` - High-dynamic-range digital light sensor
 - `VEML7700` - High-accuracy ambient light sensor
 
 ### Motion & Position Sensors
+- `ADXL335` - 3-axis analog accelerometer
+- `ADXL343` - 3-axis accelerometer with high-resolution measurements
+- `ADXL345` - 3-axis accelerometer with high resolution (13-bit)
+- `ADXL375` - High-g accelerometer for impact detection (±200g)
+- `LIS2MDL` - 3-axis magnetometer for compass applications
 - `LIS3DH` - 3-axis accelerometer
 - `LIS3MDL` - 3-axis magnetometer
+- `LSGD20H` - 3-axis gyroscope
+- `LSM63SDTR-C` - 6-axis IMU (accelerometer + gyroscope)
+- `LSM6DSO32` - 6-axis IMU with machine learning core
 - `LSM6DSOX` - 6-axis IMU (accelerometer + gyroscope)
 - `MPU6050` - 6-axis motion tracking sensor
+- `MSA311` - 3-axis accelerometer with motion detection
 - `VL53L0X` - Time-of-flight distance sensor
 - `VL53L1X` - Long-range time-of-flight sensor
+- `VL53L4CX` - Advanced time-of-flight distance sensor
+- `VL6180X` - Time-of-flight distance sensor with ambient light sensing
+
+### Pressure & Altitude Sensors
+- `BMP280` - Digital barometric pressure sensor
+- `BMP388` - High-precision barometric pressure sensor
+- `BMP390` - High-precision barometric pressure sensor for altitude measurement
+- `DPS310` - Digital barometric pressure sensor
+- `LPS22` - Digital barometric pressure sensor
+- `LPS28DFW` - Digital barometric pressure sensor with FIFO buffer
+- `MPL3115A2` - Digital barometric pressure sensor
+- `MS6807` - Digital barometric pressure sensor
 
 ### Air Quality Sensors
+- `CCS811` - Digital gas sensor for VOCs and eCO2
+- `ENS160` - Digital gas sensor for VOCs, eCO2, and TVOC
 - `PMS5003` - Particulate matter sensor 
 - `PMSA003I` - I2C particulate matter sensor 
+- `SCD30` - CO2, temperature, and humidity sensor
 - `SCD40` - CO2, temperature, and humidity sensor
-- `SGP30` - Air quality sensor
+- `SEN54` - Multi-gas environmental sensor (temperature, humidity, VOC, NOx)
+- `SEN55` - Comprehensive environmental sensor (temperature, humidity, VOC, NOx, PM)
+- `SEN66` - Environmental sensor
+- `SGP30` - Air quality sensor for eCO2 and TVOC
 - `SGP40` - VOC air quality sensor
 
+### Magnetic Field Sensors
+- `DRV5032` - Digital hall effect sensor for magnetic field detection
+- `LIS2MDL` - 3-axis magnetometer
+- `LIS3MDL` - 3-axis magnetometer
+- `MMC5603` - 3-axis magnetometer with high resolution
+- `MLX90393` - 3-axis magnetometer
+- `TLV493D` - 3-axis magnetometer
+
+### Thermal Imaging
+- `AMG8833` - 8x8 thermal camera sensor for infrared temperature measurements
+- `MLX90640` - Thermal imaging sensor
+
+### Time & Real-Time Clock
+- `DS3231` - High-accuracy real-time clock
+- `PCF8523` - Real-time clock
+
 ### Utility Commands
-- `blink` - blinks a simple LED
-- `cat` - cat a file
-- `clean` - clean unwanted files like ._file_, file~ and others from the device
--  `hello` - Hello world
-- `neopixel-blink` - blinks a NeoPixel LED
-- `neopixel-rainbow` - cycles through rainbow colors on a NeoPixel LED
-- `ntp` - get the time from an NTP server
-- `ping` - ping (ICMP Echo Request) another device
-- `reset` - restart the device (`microcontroller.reset()`)
-- `run` - reads a file on the device and executes it
+- `blink` - Blinks a simple LED
+- `cat` - Display contents of a file
+- `clean` - Clean unwanted files like ._file_, file~ and others from the device
+- `hello` - Hello world
+- `neopixel-blink` - Blinks a NeoPixel LED
+- `neopixel-rainbow` - Cycles through rainbow colors on a NeoPixel LED
+- `ntp` - Get the time from an NTP server 
+- `ping` - Ping (ICMP Echo Request) another device
+- `relay-serial` - Control a relay via serial communication
+- `reset` - Restart the device (`microcontroller.reset()`)
+- `run` - Reads a file on the device and executes it
 - `scan-i2c` - Scan for I2C devices 
 - `scan-wifi` - Scan for WiFi networks 
 - `settings` - Display contents of `settings.toml` (same as `cat settings.toml`) 
 - `system-info` - Display system information
-- `uf2` - restart compatible devices in UF2 bootloader mode (this will take the device offline if it's on wifi)
+- `uf2` - Restart compatible devices in UF2 bootloader mode (this will take the device offline if it's on wifi)
+
+### OneWire Interface
+- `DS2484` - 1-Wire master controller for I2C to 1-Wire bridge functionality