This is a CLI management tool for MicroPython-based XNode.
### Help
```sh
xnode
```
or
```sh
xnode --help
```
### Find serial port
```sh
xnode scan
```
### Option Rules
- Options and values can have spaces or omit spaces.
- Options and values can be inserted with the = character.
```sh
<option><value>
<option> <value>
<option>=<value>
```
### Initialize XNode file system (Only xnode type b)
```sh
xnode -s<com_port_name> init
```
or
```sh
xnode --sport<com_port_name> init
```
> \<com_port_name\> is the port number found by scan.
### Check list of XNode file systems
```sh
xnode -s<com_port_name> ls
xnode -s<com_port_name> ls /flash/lib/xnode/pop
```
### Put PC file or directroy into XNode
```sh
xnode -s<com_port_name> put my.py /flash/main.py
```
> my.py is the name of the script written on the PC, main.py is the name to be installed on XNode
>> Automatically runs /flash/main.py if it exists when XNode starts
### Get XNode file to PC
```sh
xnode -s<com_port_name> get /flash/main.py main.py
```
### Delete XNode file or directory
```sh
xnode -s<com_port_name> rm /flash/main.py
```
### Executes the PC's MicroPython script by sequentially passing it to the XNode
```sh
xnode -s<com_port_name> run app.py
```
> Wait for serial output until the script finishes
>> To force quit in running state, press Ctrl+c
**Additional Options**
- -in (or default): Does not display the pressed key in the terminal window (Echo off)
- -i: Display the pressed key in the terminal window (Echo on)
- -n: Does not wait for serial output, so it appears as if the program has terminated on the PC side.
- Script continues to run on XNode
- Used to check data output serially from XNode with other tools (PuTTY, smon, etc.)
Raw data
{
"_id": null,
"home_page": "https://github.com/planxstudio/xkit",
"name": "xnode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "micropython, xnode, genlib",
"author": "chanmin.park",
"author_email": "devcamp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/74/9e/c66d0e24d5d32b13c09fd9adf7671d3e66c46ff3d3e5de6c5fa593d7f75c/xnode-1.4.0.tar.gz",
"platform": null,
"description": "This is a CLI management tool for MicroPython-based XNode.\r\n\r\n### Help\r\n```sh\r\nxnode\r\n```\r\nor\r\n```sh\r\nxnode --help\r\n```\r\n\r\n### Find serial port\r\n```sh\r\nxnode scan\r\n```\r\n\r\n### Option Rules\r\n- Options and values can have spaces or omit spaces.\r\n- Options and values can be inserted with the = character.\r\n\r\n```sh\r\n<option><value> \r\n<option> <value>\r\n<option>=<value> \r\n```\r\n\r\n### Initialize XNode file system (Only xnode type b)\r\n```sh\r\nxnode -s<com_port_name> init\r\n```\r\nor\r\n```sh\r\nxnode --sport<com_port_name> init\r\n```\r\n> \\<com_port_name\\> is the port number found by scan. \r\n\r\n### Check list of XNode file systems\r\n```sh\r\nxnode -s<com_port_name> ls\r\nxnode -s<com_port_name> ls /flash/lib/xnode/pop\r\n```\r\n\r\n### Put PC file or directroy into XNode\r\n```sh\r\nxnode -s<com_port_name> put my.py /flash/main.py\r\n```\r\n> my.py is the name of the script written on the PC, main.py is the name to be installed on XNode \r\n>> Automatically runs /flash/main.py if it exists when XNode starts\r\n\r\n### Get XNode file to PC\r\n```sh\r\nxnode -s<com_port_name> get /flash/main.py main.py\r\n```\r\n\r\n### Delete XNode file or directory\r\n```sh\r\nxnode -s<com_port_name> rm /flash/main.py\r\n```\r\n\r\n### Executes the PC's MicroPython script by sequentially passing it to the XNode\r\n```sh\r\nxnode -s<com_port_name> run app.py\r\n```\r\n> Wait for serial output until the script finishes \r\n>> To force quit in running state, press Ctrl+c\r\n\r\n**Additional Options**\r\n - -in (or default): Does not display the pressed key in the terminal window (Echo off)\r\n - -i: Display the pressed key in the terminal window (Echo on)\r\n - -n: Does not wait for serial output, so it appears as if the program has terminated on the PC side.\r\n - Script continues to run on XNode\r\n - Used to check data output serially from XNode with other tools (PuTTY, smon, etc.)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "This is a CLI management tool for MicroPython-based embedded systems.",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/planxstudio/xkit"
},
"split_keywords": [
"micropython",
" xnode",
" genlib"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34af7d70061308df5c52a8f70e68c88b323e40f4f453172546efb2eb6bd0525b",
"md5": "4114ba95cd27eeb0ad21ec95ebe79d23",
"sha256": "9873b40e5d57b5eef9627cb4b5c2d97ba7c2672191cd945fc22c18696d85b7a0"
},
"downloads": -1,
"filename": "xnode-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4114ba95cd27eeb0ad21ec95ebe79d23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16330,
"upload_time": "2025-01-02T05:25:13",
"upload_time_iso_8601": "2025-01-02T05:25:13.372443Z",
"url": "https://files.pythonhosted.org/packages/34/af/7d70061308df5c52a8f70e68c88b323e40f4f453172546efb2eb6bd0525b/xnode-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "749ec66d0e24d5d32b13c09fd9adf7671d3e66c46ff3d3e5de6c5fa593d7f75c",
"md5": "f0c311deb4a7527fd97fe58ae29c208c",
"sha256": "8b4ac4b2f5420ec512584b52643f6329afd73cff7a317e788621162a5f2ba700"
},
"downloads": -1,
"filename": "xnode-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f0c311deb4a7527fd97fe58ae29c208c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16090,
"upload_time": "2025-01-02T05:25:14",
"upload_time_iso_8601": "2025-01-02T05:25:14.471489Z",
"url": "https://files.pythonhosted.org/packages/74/9e/c66d0e24d5d32b13c09fd9adf7671d3e66c46ff3d3e5de6c5fa593d7f75c/xnode-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 05:25:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "planxstudio",
"github_project": "xkit",
"github_not_found": true,
"lcname": "xnode"
}
JSON
