https://github.com/github0null/eide_shell_flasher_index
https://github.com/github0null/eide_shell_flasher_index
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/github0null/eide_shell_flasher_index
- Owner: github0null
- Created: 2022-10-29T16:10:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T08:56:56.000Z (over 1 year ago)
- Last Synced: 2025-07-21T22:45:12.682Z (7 months ago)
- Language: Python
- Size: 7.76 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## EIDE Shell Flasher Index
> 注意事项：每次新添加一个烧录器，都需要在 scripts 目录下新建一个目录，用于存放 program_flash.sh 烧录脚本，目录名就是 下面的 `id`
`index.json` type definition:
```ts
export interface ShellFlasherIndexItem {
/**
* tool id (lower case, without whitespace)
*
* format:
* '..'
*
* interface_protocol:
* uart
* swim
* swd
* jtag
*
* example:
* 'mcs51.uart.stcflash'
* 'w801.uart.wm_tool'
* 'stm8.swim.stm8flash'
*/
id: string;
/**
* human readable name
*/
name: string;
/**
* detail for this tool
*/
detail?: string;
/**
* provider (auther)
*/
provider?: string;
/**
* platform requirement, like: win32, linux, darwin ...
*/
platform: string[];
/**
* eide shell flasher config, refer: src/HexUploader.ts -> CustomFlashOptions
*/
flashConfigTemplate: {
bin: string;
commandLine: string;
eraseChipCommand: string;
}
/**
* scripts install path (default is workspace folder)
*/
scriptInstallDir?: string;
/**
* binary resources (optional)
*/
resources: {
// platform require, like: win32, linux, darwin ...
[platform: string]: {
url: string; // zip, 7z direct download link (https), like: 'https://test.com/gcc.zip'
zipType: 'zip' | '7z' | 'none'; // if zipType == 'none', field 'url' will be ignored
locationType: 'workspace' | 'global';
/**
* if 'locationType' == 'workspace', Install Dir is '${workspaceFolder}/'
*
* if 'locationType' == 'global', Install Dir is '${userHome}/.eide/tools/'
*/
location: string;
setupCommand?: string; // (optional) This command will be execuate after resource has been unziped
}
}
}
```