# Chip-tool-gui

**Repository Path**: yeshenmeng/chip-tool-gui

## Basic Information

- **Project Name**: Chip-tool-gui
- **Description**: No description available
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-05-13
- **Last Updated**: 2024-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MatterChipToolClient 
An ssh client for Matter chip-tool, user can execute chip tool related instructions through the GUI directly, without having to remember complex Matter commands.
# How to Use It
## Preparation
An Ubuntu host with chip-tool is Necessary, I suggest you to copy chip-tool,chip-cert and chip-ota-provider-app to a dir under the /home/user/apps/ path.  
Make Sure your account has the OWN right to the whole path of ~/apps.

ubuntu@ubuntu:~/apps$ tree -L 1  
.  
├── ack_paa  
├── chip-all-clusters-app  
├── chip-all-clusters-app.map  
├── chip-bridge-app  
├── chip-bridge-app.map  
├── chip-cert  
├── chip-cert.map
├── chip-ota-provider-app  
├── chip-shell  
├── chip-shell.map  
├── chip-tool  
├── chip-tool-utils.a  
├── chip-tool.map
├── ota_path  
├── sengled_paa  
├── sengled_test_paa   
└── zap_gen.lock  
 

The configuration of Chip-tool is stored to /tmp， you'd better change the owner of this path to [user-name], otherwise, you will have no right to reset chip-tool host.  

## 1.chip-tool app path setting
For example, the default path of chip-tool is set to '~/apps', you can modify the path and point to your own path.

App path setting: [the absolute path of chip-tool in your ubuntu host] Set

Note: You need to do this execution everytime you log in, so, if there is no special purpose, please do not modify the default directory.  

## 2. pair matter device to chip-tool
### 2.1 ble-wifi
Passcode and Long Discriminator are needed, you can get them by parsing qr-code.  

### 2.2 onnetwork
If you want to test OTA firmware upgrade feature, you should activate the OTA.bin file then pair ubuntu host as an ota-provider device which device type is onnetwork.
## 3.ota configuration
### 3.1 ota_path  
    ~/apps/ota_path/   
 This dir will be created when ssh connected if it not exists. 
### 3.2 ota operation stages
    a). Uploads ota.bin file and activates it.  
    b). Commission Chip-tool host to Fabric via 'onnetwrok' mode, with node-id '110'.  
    c). Complete the 'ACL' settings.  
    d). Commission Dut to the same Fabric.  
    e). Send AnnounceOtaProvider Command to Dut, provider-id is '110'.

# 4. Release Note
## v2.4 Aug 22, 2023
### v24_b Bug fixes or Optimization
    v24_b.1 Fixed Nothing. Hopefully, the crash problem has been resolved
    v24_b.1 Optimize OTA log display 
### 24_f. New Feature
    24_f.1 Descriptor Page, add 'EndPoint' element, choose endpoint for read command.
    24_f.2 Using queue module in threaded method when information be exchanged wiht main thread

## v2.3 Aug 7, 2023
### 23_b. Bug fixes or Optimization
    23_b.1 Fixed 'fabirc_paring' bug, replace 'tp_link_paa' to 'sengled_test_paa';
    23_b.2 Fixed 'socket.timeout', assert read_ready() before ssh_channel.recv();
    23_b.3 Change two attribute Names, 'identy time' to 'IdentyTime', 'identy type'  to 'IdentyType';
### 23_f. New Feature
    23_f.1 Commple otbr features, such as 'dataset read and fill', 'otbr_xx_status check', etc..
    23_f.2 Parse CertificateChainResponse(DAC/PAI), CSRResponse(CSR) by '--trace_decode 1'

## v2.2 Aug 2, 2023
### 22_b. Bug fixes or Optimization  
    22_b.1. 修复dut为空时解析qr-code及pairing 时提示'node id invalid' 问题；  
    22_b.2. 优化read-by-id 0xFFFFFFFF回显解析机制； 
         Known Issue: 跨msg显示的消息无法解析，读取回显过多的Cluster有概率崩溃，如ColorControlCluster
### 22_f. New Features  
    22_f.1. 新增Node Behavior using BCM、Attribute Read of Cluster 0x003C_Administrator Commissioning;  
    22_f.2. 新增Commissioning阶段关键信息及报错打印，如SetupCode错误、提取VendorID/ProductID、AttestationVerificationResult
    22_f.3. 新增ble-thread commissioning, rcp is needed.

## v2.1  Aug 1, 2023
### 21_b. Bug fixes or Optimization  
    21_b.1 修改app-path,  --paa-trust-store-path，根据登录用户名动态生成；
### 21_f. New Features  
    21_f.1. 校验paa-trust-store-path, 不存在则创建并上传'xx-paa.der';    
         TODO：bugfix --> 'No such file' exception raised when sftp.put  
    21_f.2. new chip-tool 指令及回显兼容适配(sdk: v1.1),如 bssid->BSSID, Rssi->RSSI, VendorId->VendorID, 
         NodeId->NodeID, FabricId->FabricID

# 5. New Features Developing Plan
    5.1. Openthread board router  --> Done
    5.2. Groups
    5.3. Scenes
    
# 6. Known Bug List
    None