https://github.com/blueandi/vscp-cli-tools
Very Simple Control Protocol (VSCP) Level 1 CLI Tools
https://github.com/blueandi/vscp-cli-tools
automation c99 homeautomation vscp vscp-framework
Last synced: about 1 year ago
JSON representation
Very Simple Control Protocol (VSCP) Level 1 CLI Tools
- Host: GitHub
- URL: https://github.com/blueandi/vscp-cli-tools
- Owner: BlueAndi
- License: other
- Created: 2021-09-15T19:53:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-17T17:46:41.000Z (over 1 year ago)
- Last Synced: 2025-02-02T04:44:25.655Z (over 1 year ago)
- Topics: automation, c99, homeautomation, vscp, vscp-framework
- Language: C
- Homepage:
- Size: 5.86 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VSCP CLI Tools
[](http://choosealicense.com/licenses/mit/)
[](https://www.repostatus.org/#active)
[](https://github.com/BlueAndi/vscp-cli-tools/releases)
Command line interface tools used to maintain or simulate VSCP nodes.
- [VSCP CLI Tools](#vscp-cli-tools)
- [VSCP](#vscp)
- [Tools](#tools)
- [How To Build](#how-to-build)
- [Prerequisite](#prerequisite)
- [Linux](#linux)
- [Windows](#windows)
- [1 Clone The Repository](#1-clone-the-repository)
- [2 Choose Project](#2-choose-project)
- [3 Build](#3-build)
- [Used Libraries](#used-libraries)
- [Issues, Ideas And Bugs](#issues-ideas-and-bugs)
- [License](#license)
- [Contribution](#contribution)
# VSCP
The Very Simple Control Protocol (VSCP), an open and free protocol for IoT/m2m automation tasks.
More information can be found on the main site http://www.vscp.org
# Tools
| Project | Description |
| :------: | :---------: |
| logger | Tool which shows VSCP events on the command line, which are received by a daemon connection. |
| nodeSim | Simulates a single VSCP node. It can be called several times with different configurations to simulate more than one VSCP node. |
| programmer | Tool to program VSCP nodes over a VSCP daemon connection. It uses the VSCP standard bootloader algorithm. |
# How To Build
## Prerequisite
### Linux
1. Open a terminal.
2. Call ```setup_linux.sh```
### Windows
1. Install MSYS2 (https://www.msys2.org/) and follow the complete installation instructions there. Only installing the MSYS2 binary is not enough! There are several steps in the MSYS2 shell necessary.
2. The gcc build environment will be available in the "MSYS2 MinGW UCRT 64-bit" shell.
3. Install expat packages:
```bash
pacman -S libexpat
pacman -S libexpat-devel
```
4. Install required visual studio runtime packages:
* https://aka.ms/vs/17/release/vc_redist.x86.exe
* https://aka.ms/vs/17/release/vc_redist.x64.exe
## 1 Clone The Repository
The [vscp-framework](https://github.com/BlueAndi/vscp-framework) is added as git submodule. Therefore use
```
$ git clone --recursive https://github.com/BlueAndi/vscp-cli-tools.git
```
If already cloned and just a update of the vscp-framework shall be done, use:
```
$ git submodule update --remote
```
## 2 Choose Project
Choose the project by entering the corresponding folder, e.g. ```/nodeSim```.
## 3 Build
Build debug variant with ```make debug``` or use ```make release``` for the release variant.
The result will be in the ```//bin``` folder.
# Used Libraries
| Library | Description | License |
| - | - | - |
| [Expat](https://github.com/libexpat/libexpat) | Fast streaming XML parser. | MIT |
| [OpenSSL](https://github.com/openssl/openssl) | OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the TLS (formerly SSL), DTLS and QUIC (currently client side only) protocols. | Apache-2.0 |
| [vscp-helper-lib](https://github.com/grodansparadis/vscp-helper-lib) | VSCP helper functionality | MIT |
# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/vscp-cli-tools/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
# License
The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).
# Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.