src/controller/README.md

   1 # CHIP controller
   2
   3 There are currently 4 implementations of the CHIP device controller with varying
   4 support for certain CHIP features.
   5
   6 ## Implementations
   7
   8 ### iOS
   9
  10 The iOS chip-tool is located in [../darwin/CHIPTool](../darwin/CHIPTool).
  11
  12 ### Android
  13
  14 The Android chip-tool is located in [../android/CHIPTool](../android/CHIPTool).
  15
  16 ### POSIX CLI
  17
  18 The POSIX CLI chip-tool is located in
  19 [../../examples/chip-tool](../../examples/chip-tool).
  20
  21 ### Python
  22
  23 The Python chip-device-ctrl is located in
  24 [../controller/python/](../controller/python).
  25
  26 ## Feature Overview
  27
  28 | Onboarding | iOS | Android | CLI | Python |
  29 | ---------- | --- | ------- | --- | ------ |
  30 | Setup code | y?  | n       | y   | y      |
  31 | QR code    | y   | y       | n   | n      |
  32 | NFC        | y   | y       | n   | n      |
  33
  34 | Provisioning | iOS    | Android | CLI | Python |
  35 | ------------ | ------ | ------- | --- | ------ |
  36 | Soft-AP      | y      | n       | y   | y      |
  37 | WiFi-BLE     | y?     | y       | y   | y      |
  38 | Thread-BLE   | n(\*0) | y(\*1)  | n   | y(\*1) |
  39
  40 | Commands/Clusters   | iOS | Android | CLI | Python |
  41 | ------------------- | --- | ------- | --- | ------ |
  42 | Echo Client         | y?  | y       | y   | y      |
  43 | On/Off Client       | y   | y       | y   | y      |
  44 | LevelControl Client | ?   | y       | y   | y      |
  45 | Identify Client     | ?   | n(\*2)  | y   | y      |
  46 | Scene Client        | n?  | n(\*2)  | y   | y      |
  47 | Group Client        | n?  | n(\*2)  | y   | y      |
  48 | Binding Client      | n?  | n(\*2)  | y   | y      |
  49
  50 | Attributes/Clusters | iOS | Android | CLI | Python |
  51 | ------------------- | --- | ------- | --- | ------ |
  52 | Read                | n   | n(\*2)  | y   | n      |
  53 | Write               | n   | n(\*2)  | y   | n      |
  54
  55 |                  | iOS | Android | CLI | Python |
  56 | ---------------- | --- | ------- | --- | ------ |
  57 | Multiple Devices | y   | n(\*3)  | ?   | ?      |
  58
  59 Notes:
  60
  61 (\*0) <https://github.com/project-chip/connectedhomeip/pull/4829>
  62
  63 (\*1) Only static commissioning, not MeshCoP.
  64
  65 (\*2) Locally a patch exists, could be upstreamed.
  66
  67 (\*3) Uses deprecated Chip Device Controller, move to new CHIP Device controller
  68 WIP according to Slack conversation.