{"id":15066408,"url":"https://github.com/houseos/secure_control_protocol","last_synced_at":"2025-07-26T17:33:42.328Z","repository":{"id":43497179,"uuid":"265835631","full_name":"houseos/secure_control_protocol","owner":"houseos","description":"Dart library for the secure-control-protocol","archived":false,"fork":false,"pushed_at":"2022-03-18T10:49:37.000Z","size":148,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"development","last_synced_at":"2025-03-24T12:21:45.250Z","etag":null,"topics":["chacha20-poly1305","dart","home-automation","iot","open-source","security"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/houseos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-21T11:52:13.000Z","updated_at":"2023-11-15T11:12:34.000Z","dependencies_parsed_at":"2022-08-23T13:10:41.392Z","dependency_job_id":null,"html_url":"https://github.com/houseos/secure_control_protocol","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/houseos%2Fsecure_control_protocol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/houseos%2Fsecure_control_protocol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/houseos%2Fsecure_control_protocol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/houseos%2Fsecure_control_protocol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/houseos","download_url":"https://codeload.github.com/houseos/secure_control_protocol/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248226251,"owners_count":21068169,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chacha20-poly1305","dart","home-automation","iot","open-source","security"],"created_at":"2024-09-25T01:07:35.800Z","updated_at":"2025-04-10T13:42:47.388Z","avatar_url":"https://github.com/houseos.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Secure Control Protocol Client Library written in Dart\n\nThis 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).\n\nIt also provides a very basic CLI client for demonstration purposes.\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n## Build and run for development\n\nInstall the Dart SDK version \u003e 2.10.\n\nAfterwards run `pub get` to fetch all dependencies.\n\nNow the commands below can be used.\n\n## Build as native application\n\n`dart compile exe ./bin/scp_client.dart`\n\n## Run without build\n\nSee below.\n\n## Run Tests\n\n`dart run \u003cpath to test\u003e`\n\n## CLI Client\n\nThe CLI client supports all necessary commands:\n\n```\n\u003e dart .\\bin\\scp_client.dart help\nSecure Control Protocol CLI Client\n\nUsage: scp-client.exe \u003ccommand\u003e [arguments]\n\nGlobal options:\n-h, --help    Print this usage information.\n\nAvailable commands:\n  control     Control the selected device.\n  discover    Discover all devices in a given IP range.\n  measure     Measure a value.\n  provision   Provision all available devices.\n  rename      Rename the selected device.\n  reset       Reset the selected device.\n  update      Update the IP addresses of all devices in a given IP range.\n\nRun \"scp-client.exe help \u003ccommand\u003e\" for more information about a command.\n```\n\n### Control\n\n```\n\u003e dart .\\bin\\scp_client.dart help control\nControl the selected device.\n\nUsage: scp-client.exe control [arguments]\n-h, --help                                                                     Print this usage information.\n-c, --command=\u003cAny string registered in the device.\u003e                           The command to send to the device.\n-d, --deviceId=\u003cCan be looked up in the json with the provisioned devices.\u003e    The ID of the device to control.\n-j, --json=\u003cPath in the filesystem.\u003e                                           Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options.\n```\n\n### Discover\n\n```\n\u003e dart .\\bin\\scp_client.dart help discover\nDiscover all devices in a given IP range.\n\nUsage: scp-client.exe discover [arguments]\n-h, --help                                          Print this usage information.\n-i, --ipaddress=\u003cIPv4 Address (AAA.BBB.CCC.DDD)\u003e    IP address from the subnet to be scanned.\n-m, --mask=\u003c0 - 32\u003e                                 The subnet mask of the network to scan.\n-j, --json=\u003cPath in the filesystem.\u003e                Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options.\n```\n\n### Measure\n\n```\n\u003e dart .\\bin\\scp_client.dart help measure\nMeasure a value.\n\nUsage: scp-client.exe measure [arguments]\n-h, --help                                                                     Print this usage information.\n-a, --action=\u003cAny string registered in the device.\u003e                            The measure action to send to the device.\n-d, --deviceId=\u003cCan be looked up in the json with the provisioned devices.\u003e    The ID of the device to control.\n-j, --json=\u003cPath in the filesystem.\u003e                                           Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options\n```\n\n### Provision \n\n```\n\u003e dart .\\bin\\scp_client.dart help provision\nProvision all available devices.\n\nUsage: scp-client.exe provision [arguments]\n-h, --help                                          Print this usage information.\n-i, --ipaddress=\u003cIPv4 Address (AAA.BBB.CCC.DDD)\u003e    IP address from the subnet to be scanned.\n-m, --mask=\u003c0 - 32\u003e                                 The subnet mask of the network to scan.\n-s, --ssid=\u003cSSID\u003e                                   The SSID of the Wifi the device should connect to.\n-p, --password=\u003cString (32 Characters)\u003e             The Wifi password.\n-j, --json                                          Export the provisioned devices to the given JSON file to be able to load them for the next command.\n\nRun \"scp-client.exe help\" to see global options\n```\n\n### Rename\n\n```\n\u003e dart .\\bin\\scp_client.dart help rename   \nRename the selected device.\n\nUsage: scp-client.exe rename [arguments]\n-h, --help                                                                     Print this usage information.\n-d, --deviceId=\u003cCan be looked up in the json with the provisioned devices.\u003e    The ID of the device to control.\n-n, --name=\u003c\u003e                                                                  The new name of the device.\n-j, --json=\u003cPath in the filesystem.\u003e                                           Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options.\n```\n\n### Reset\n\n```\n\u003e dart .\\bin\\scp_client.dart help reset \nReset the selected device.\n\nUsage: scp-client.exe reset [arguments]\n-h, --help                                                                     Print this usage information.\n-d, --deviceId=\u003cCan be looked up in the json with the provisioned devices.\u003e    The ID of the device to control.\n-j, --json=\u003cPath in the filesystem.\u003e                                           Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options.\n```\n\n### Update \n\n```\n\u003e dart .\\bin\\scp_client.dart help update\nUpdate the stored information of all devices in a given IP range.\n\nUsage: scp-client.exe update [arguments]\n-h, --help                                          Print this usage information.\n-i, --ipaddress=\u003cIPv4 Address (AAA.BBB.CCC.DDD)\u003e    IP address from the subnet to be scanned.\n-m, --mask=\u003c0 - 32\u003e                                 The subnet mask of the network to scan.\n-j, --json=\u003cPath in the filesystem.\u003e                Path to the JSON file containing all known devices.\n\nRun \"scp-client.exe help\" to see global options.\n```\n\n## License\nSPDX-License-Identifier: GPL-3.0-only\n\nThe full version of the license can be found in LICENSE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhouseos%2Fsecure_control_protocol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhouseos%2Fsecure_control_protocol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhouseos%2Fsecure_control_protocol/lists"}