Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houseos/scp4j
Java Client Library for secure-control-protocol devices
https://github.com/houseos/scp4j
Last synced: about 2 months ago
JSON representation
Java Client Library for secure-control-protocol devices
- Host: GitHub
- URL: https://github.com/houseos/scp4j
- Owner: houseos
- License: gpl-3.0
- Created: 2019-05-22T20:57:40.000Z (over 5 years ago)
- Default Branch: development
- Last Pushed: 2022-05-20T21:56:35.000Z (over 2 years ago)
- Last Synced: 2024-04-24T07:10:31.116Z (9 months ago)
- Language: Java
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secure Control Protocol Client Library written in Java
## Dependencies
- [Java Development Kit](https://openjdk.java.net/ "OpenJDK") 1.8
- [Maven](https://maven.apache.org/ "Apache Maven") >= 3.6
## Build
To build the project navigate to its root folder and run:
`mvn package`
## Run
Run the program with:
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar`
## CLI Client
``` lang-none
Usage: scp4j [-h] [COMMAND]
Secure Control Protocol CLI Client
-h, --help Print this usage information.
Commands:
control Control the selected device.
discover Discover all devices in a given IP range.
provision Provision all available devices.
reset Reset the selected device.
update Update the IP addresses of all devices in a given IP range.
```
### control
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar control`
``` lang-none
Usage: scp4j control [-h] -c= -d= -j=
Control the selected device.
-c, --command= The command to send to the device.
-d, --deviceId= The ID of the device to control.
-h, --help Print this usage information.
-j, --json= Path to the JSON file containing all known devices.
```
### discover
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar discover`
``` lang-none
Usage: scp4j discover [-h] -i= -m=
Discover all devices in a given IP range.
-h, --help Print this usage information.
-i, --ipaddress=
IP address from the subnet to be scanned.
-m, --mask= The subnet mask of the network to scan.
```
### provision
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar provision`
``` lang-none
Usage: scp4j provision [-h] -i= -j= -m=
-p= -s=
Provision all available devices.
-h, --help Print this usage information.
-i, --ipaddress=
IP address from the subnet to be scanned.
-j, --json= Export the provisioned devices to the given JSON file
to be able to load them for the next command.
-m, --mask= The subnet mask of the network to scan.
-p, --password=
The Wifi password.
-s, --ssid= The SSID of the Wifi the device should connect to.
```
### reset
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar reset`
``` lang-none
Usage: scp4j reset [-h] -d= -j=
Reset the selected device.
-d, --deviceId=
The ID of the device to control.
-h, --help Print this usage information.
-j, --json= Path to the JSON file containing all known devices.
```
### update
`java -jar target/scp4j-0.0.1-SNAPSHOT-jar-with-dependencies.jar update`
``` lang-none
Usage: scp4j update [-h] -i= -j= -m=
Update the IP addresses of all devices in a given IP range.
-h, --help Print this usage information.
-i, --ipaddress=
IP address from the subnet to be scanned.
-j, --json= Path to the JSON file containing all known devices.
-m, --mask= The subnet mask of the network to scan.
```
## License
SPDX-License-Identifier: GPL-3.0-only
The full version of the license can be found in LICENSE.