Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houseos/secure_control_protocol
Dart library for the secure-control-protocol
https://github.com/houseos/secure_control_protocol
chacha20-poly1305 dart home-automation iot open-source security
Last synced: 3 months ago
JSON representation
Dart library for the secure-control-protocol
- Host: GitHub
- URL: https://github.com/houseos/secure_control_protocol
- Owner: houseos
- License: gpl-3.0
- Created: 2020-05-21T11:52:13.000Z (over 4 years ago)
- Default Branch: development
- Last Pushed: 2022-03-18T10:49:37.000Z (almost 3 years ago)
- Last Synced: 2024-10-13T02:02:39.054Z (3 months ago)
- Topics: chacha20-poly1305, dart, home-automation, iot, open-source, security
- Language: Dart
- Homepage:
- Size: 145 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Secure Control Protocol Client Library written in Dart
This is a client library for IoT devices implementing the [Secure Control Protocol](https://github.com/houseos/SCP). It is used by the [HouseOS Client App](https://github.com/houseos/houseos_client).
It also provides a very basic CLI client for demonstration purposes.
[](https://www.gnu.org/licenses/gpl-3.0)
## Build and run for development
Install the Dart SDK version > 2.10.
Afterwards run `pub get` to fetch all dependencies.
Now the commands below can be used.
## Build as native application
`dart compile exe ./bin/scp_client.dart`
## Run without build
See below.
## Run Tests
`dart run `
## CLI Client
The CLI client supports all necessary commands:
```
> dart .\bin\scp_client.dart help
Secure Control Protocol CLI Client
Usage: scp-client.exe [arguments]
Global options:
-h, --help Print this usage information.
Available commands:
control Control the selected device.
discover Discover all devices in a given IP range.
measure Measure a value.
provision Provision all available devices.
rename Rename the selected device.
reset Reset the selected device.
update Update the IP addresses of all devices in a given IP range.
Run "scp-client.exe help " for more information about a command.
```
### Control
```
> dart .\bin\scp_client.dart help control
Control the selected device.
Usage: scp-client.exe control [arguments]
-h, --help Print this usage information.
-c, --command= The command to send to the device.
-d, --deviceId= The ID of the device to control.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options.
```
### Discover
```
> dart .\bin\scp_client.dart help discover
Discover all devices in a given IP range.
Usage: scp-client.exe discover [arguments]
-h, --help Print this usage information.
-i, --ipaddress= IP address from the subnet to be scanned.
-m, --mask=<0 - 32> The subnet mask of the network to scan.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options.
```
### Measure
```
> dart .\bin\scp_client.dart help measure
Measure a value.
Usage: scp-client.exe measure [arguments]
-h, --help Print this usage information.
-a, --action= The measure action to send to the device.
-d, --deviceId= The ID of the device to control.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options
```
### Provision
```
> dart .\bin\scp_client.dart help provision
Provision all available devices.
Usage: scp-client.exe provision [arguments]
-h, --help Print this usage information.
-i, --ipaddress= IP address from the subnet to be scanned.
-m, --mask=<0 - 32> The subnet mask of the network to scan.
-s, --ssid= The SSID of the Wifi the device should connect to.
-p, --password= The Wifi password.
-j, --json Export the provisioned devices to the given JSON file to be able to load them for the next command.
Run "scp-client.exe help" to see global options
```
### Rename
```
> dart .\bin\scp_client.dart help rename
Rename the selected device.
Usage: scp-client.exe rename [arguments]
-h, --help Print this usage information.
-d, --deviceId= The ID of the device to control.
-n, --name=<> The new name of the device.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options.
```
### Reset
```
> dart .\bin\scp_client.dart help reset
Reset the selected device.
Usage: scp-client.exe reset [arguments]
-h, --help Print this usage information.
-d, --deviceId= The ID of the device to control.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options.
```
### Update
```
> dart .\bin\scp_client.dart help update
Update the stored information of all devices in a given IP range.
Usage: scp-client.exe update [arguments]
-h, --help Print this usage information.
-i, --ipaddress= IP address from the subnet to be scanned.
-m, --mask=<0 - 32> The subnet mask of the network to scan.
-j, --json= Path to the JSON file containing all known devices.
Run "scp-client.exe help" to see global options.
```
## License
SPDX-License-Identifier: GPL-3.0-only
The full version of the license can be found in LICENSE.