esp-qa/coexist-cmd

readme

# External Coexist Command

This repository contains `extcoex` command based on esp-idf console for configuring external coexistence GPIO signaling.

## Documentation

- Use `help` for overview of command:

  ```
  extcoex  [-m <mode>] [-w <wire_type>] [-r <request_pin>] [-g <grant_pin>] [-p <priority_pin>] [-t <tx_line_pin>] [--disable]
    configure external coexistence mode and GPIO pins
    -m, --mode=<mode>  set the ext coex work mode (0: EXTERNAL_COEX_LEADER_ROLE; 1: EXTERNAL_COEX_FOLLOWER_ROLE)
    -w, --wire=<wire_type>  set the ext coex wire type (0: 1-wire, 1: 2-wires, 2: 3-wires, 3: 4-wires)
    -r, --request_pin=<request_pin>  set the ext coex request pin
    -g, --grant_pin=<grant_pin>  set the ext coex grant pin
    -p, --priority_pin=<priority_pin>  set the ext coex priority pin
    -t, --tx_line_pin=<tx_line_pin>  set the ext coex tx line pin
    -d, --disable  disable external coexistence
  ```

- Wire mode requirements:

  - 1-wire mode: `request_pin` is required
  - 2-wire mode: `request_pin` and `grant_pin` are required
  - 3-wire mode: `request_pin`, `grant_pin`, and `priority_pin` are required
  - 4-wire mode: `request_pin`, `grant_pin`, `priority_pin`, and `tx_line_pin` are required