Merge pull request #10 from openmv/update_readme

misc: Update readme.

Author: iabdalkader

README.md

@@ -8,46 +8,22 @@ Python library and CLI for communicating with OpenMV cameras using Protocol V2.
 pip install openmv
 ```
 
-For video streaming support (requires pygame):
-
-```bash
-pip install openmv[gui]
-```
-
 ## CLI Usage
 
 ### Stream Video
 
 ```bash
-# Stream from default port (/dev/ttyACM0)
-openmv
-
 # Stream from specific port
-openmv --port /dev/ttyACM1
+openmv --port /dev/ttyACM0
 
 # Run a custom script
 openmv --script my_script.py
 
 # Adjust display scale
 openmv --scale 2
-```
-
-### Camera Info
-
-```bash
-openmv --info
-```
-
-### Reset Camera
-
-```bash
-openmv --reset
-```
 
-### Enter Bootloader
-
-```bash
-openmv --boot
+# Enable firmware symbols
+openmv --firmware path/to/firmware.elf
 ```
 
 ### Benchmark Mode
@@ -58,42 +34,56 @@ openmv --bench
 
 ### Controls (Stream Mode)
 
-- `C` - Capture screenshot to `capture.png`
 - `ESC` - Exit
+- `P` - Cycle profiler overlay (Off → Performance → Events)
+- `M` - Toggle profiler mode (Inclusive ↔ Exclusive)
+- `R` - Reset profiler counters
 
 ## Library Usage
 
 ```python
-from openmv import OMVCamera
+from openmv import Camera
+
+script = """
+import csi, time
 
-# Connect to camera
-with OMVCamera('/dev/ttyACM0') as camera:
-    # Get system info
-    info = camera.system_info()
-    print(f"Firmware: {info['firmware_version']}")
-
-    # Execute a script
-    camera.exec('''
-import csi
 csi0 = csi.CSI()
 csi0.reset()
-''')
+csi0.pixformat(csi.RGB565)
+csi0.framesize(csi.QVGA)
+clock = time.clock()
+while True:
+    clock.tick()
+    img = csi0.snapshot()
+    print(clock.fps(), "FPS")
+"""
+
+# Connect to camera
+with Camera('/dev/ttyACM0') as camera:
+    # Stop running script (if any)
+    camera.stop()
+
+    # Execute script and enable streaming
+    camera.exec(script)
+    camera.streaming(True, raw=False, res=(512, 512))
 
-    # Read frames
-    camera.streaming(True)
+    # Read frames and output
     while True:
         if frame := camera.read_frame():
             print(f"Frame: {frame['width']}x{frame['height']}")
+
+        if text := camera.read_stdout():
+            print(text, end='')
 ```
 
 ## API Reference
 
-### OMVCamera
+### Camera
 
 Main class for camera communication.
 
 ```python
-OMVCamera(
+Camera(
     port,               # Serial port (e.g., '/dev/ttyACM0')
     baudrate=921600,    # Serial baudrate
     crc=True,           # Enable CRC validation
@@ -103,36 +93,58 @@ OMVCamera(
     timeout=1.0,        # Protocol timeout in seconds
     max_retry=3,        # Maximum retries
     max_payload=4096,   # Maximum payload size
+    drop_rate=0.0,      # Packet drop simulation (testing only)
 )
 ```
 
 #### Methods
 
+**Connection Management:**
 - `connect()` / `disconnect()` - Manage connection
+- `is_connected()` - Check connection status
+
+**Script Execution:**
 - `exec(script)` - Execute a MicroPython script
 - `stop()` - Stop the running script
-- `reset()` - Reset the camera
-- `boot()` - Enter bootloader mode
+
+**Video Streaming:**
 - `streaming(enable, raw=False, res=None)` - Enable/disable video streaming
-- `read_frame()` - Read a video frame
-- `read_stdout()` - Read script output
-- `read_status()` - Poll channel status
+- `read_frame()` - Read a video frame (returns dict with width, height, format, depth, data, raw_size)
+
+**Output and Status:**
+- `read_stdout()` - Read script output text
+- `read_status()` - Poll channel status (returns dict of channel readiness)
+
+**Channel Operations:**
+- `has_channel(name)` - Check if a channel exists
+- `channel_read(name, size=None)` - Read data from a custom channel
+- `channel_write(name, data)` - Write data to a custom channel
+- `channel_size(name)` - Get size of available data in a channel
+
+**Profiler (if available):**
+- `read_profile()` - Read profiler data
+- `profiler_mode(exclusive)` - Set profiler mode (inclusive/exclusive)
+- `profiler_reset(config=None)` - Reset profiler counters
+- `profiler_event(counter_num, event_id)` - Configure event counter
+
+**System Information:**
 - `system_info()` - Get camera system information
-- `channel_read(name)` / `channel_write(name, data)` - Custom channel I/O
+- `host_stats()` / `device_stats()` - Get protocol statistics
 
 ### Exceptions
 
-- `OMVPException` - Base protocol exception
-- `OMVPTimeoutException` - Timeout during communication
-- `OMVPChecksumException` - CRC validation failure
-- `OMVPSequenceException` - Sequence number mismatch
+- `OMVException` - Base protocol exception
+- `TimeoutException` - Timeout during communication
+- `ChecksumException` - CRC validation failure
+- `SequenceException` - Sequence number mismatch
 
 ## Requirements
 
 - Python 3.8+
-- pyserial
-- numpy
-- pygame (optional, for video streaming)
+- pyserial >= 3.5
+- numpy >= 1.20.0
+- pygame >= 2.0.0
+- pyelftools
 
 ## License