Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houseos/scp
Arduino library for secure-control-protocol devices
https://github.com/houseos/scp
chacha20-poly1305 esp8266 http iot json protocol rest security wifi
Last synced: about 16 hours ago
JSON representation
Arduino library for secure-control-protocol devices
- Host: GitHub
- URL: https://github.com/houseos/scp
- Owner: houseos
- License: gpl-3.0
- Created: 2018-09-20T19:13:39.000Z (about 6 years ago)
- Default Branch: development
- Last Pushed: 2022-03-18T10:48:29.000Z (over 2 years ago)
- Last Synced: 2024-04-24T07:10:30.640Z (7 months ago)
- Topics: chacha20-poly1305, esp8266, http, iot, json, protocol, rest, security, wifi
- Language: C++
- Homepage:
- Size: 717 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# secure-control-protocol - Arduino Library
[](https://app.fossa.io/projects/git%2Bgithub.com%2FbenjaminSchilling33%2Fsecure-control-protocol?ref=badge_shield)
The protocol specification can be found in `doc/`.
## Dependencies
The SCP Arduino library uses the rBase64 library and esp8266 core libraries.
They can be found in the repositories described in the library.json file.
## Installation
To install the library copy it into your Arduino Libraries directory.
## Integrating SCP
We made integrating SCP as easy as possible.
Several examples of successful integrations can be found in the [scp-devices](https://github.com/HouseOS/scp-devices) repository.
The following Arduino Sketch outlines how the library can be included.
```cpp
// First include the SCP library and create a SCP object
#include
SCP scp;
//To register function pointers include the std::placeholders namespace
using namespace std::placeholders;
void setup(void)
{
pinMode(D5, OUTPUT);
pinMode(D6, OUTPUT);
Serial.begin(115200);
Serial.println("");
// Initialize the SCP object
// First parameter is the device type
// Second parameters contains all control actions
// Third parameter contains all measure actions (in this case: none)
scp.init("shutter-control", "\"up\",\"down\",\"stop\"", "");
// Register your control functions.
scp.registerControlFunction(std::bind(control, _1));
scp.registerMeasureFunction(std::bind(measure, _1));
}
// In the control function define all supported actions,
// each action is identified by a unique string
void control(String action){
Serial.println("control: " + action);
if(action == "up"){
digitalWrite(D5, 1);
digitalWrite(D6, 0);
}
if(action == "down"){
digitalWrite(D6, 1);
digitalWrite(D5, 0);
}
if(action == "stop"){
digitalWrite(D5, 0);
digitalWrite(D6, 0);
}
}
double measure(String action){
Serial.println("No measure action available.");
}
void loop(void)
{
// In the loop call the handleClient
// function to listen for HTTP requests
scp.handleClient();
}
```
## License
SPDX-License-Identifier: GPL-3.0-or-later
The full version of the license can be found in LICENSE.
[](https://app.fossa.io/projects/git%2Bgithub.com%2FbenjaminSchilling33%2Fsecure-control-protocol?ref=badge_large)
If you need a license for commercial use, please contact [Benjamin Schilling](mailto:[email protected]).
## Copyright
Copyright (C) 2018 - 2021 Benjamin Schilling