Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Reference.md

This commit is contained in:
HomeSpan 2022-02-10 20:48:16 -06:00 committed by GitHub
parent 4270760c40
commit 65f000d65e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Reference.md
View File

@ -129,11 +129,8 @@ The following **optional** `homeSpan` methods enable additional features and pro
* if *s* contains an invalid code, an error will be reported and the code will *not* be saved. Instead, the currently-stored Pairing Code (or the HomeSpan default Pairing Code if no code has been stored) will be used * if *s* contains an invalid code, an error will be reported and the code will *not* be saved. Instead, the currently-stored Pairing Code (or the HomeSpan default Pairing Code if no code has been stored) will be used
* :exclamation: SECURTY WARNING: Hardcoding a device's Pairing Code into your sketch is considered a security risk and is **not** recommended. Instead, use one of the more secure methods provided by HomeSpan, such as typing 'S \<code\>' from the CLI, or launching HomeSpan's Access Point, to set your Pairing Code without hardcoding it into your sketch * :exclamation: SECURTY WARNING: Hardcoding a device's Pairing Code into your sketch is considered a security risk and is **not** recommended. Instead, use one of the more secure methods provided by HomeSpan, such as typing 'S \<code\>' from the CLI, or launching HomeSpan's Access Point, to set your Pairing Code without hardcoding it into your sketch
* void `processSerialCommand(char *c)` * `deleteStoredValues()`
* processes the character string *c* as if it were typed into the Arduino Serial Monitor * deletes the value settings of all stored Characteristics from the NVS
* allows for programmatic calls to [HomeSpan CLI commands](.../CLI.md)
* example: `homeSpan.processSerialCommand("V");` deletes the values of all stored Characteristics from the NVS
* example: `homeSpan.processSerialCommand("Q id");` changes the QR Code Setup ID to *id* (this is effectively the same as using the `setQRID()` method above)
* `void setSketchVersion(const char *sVer)` * `void setSketchVersion(const char *sVer)`
* sets the version of a HomeSpan sketch to *sVer*, which can be any arbitrary character string * sets the version of a HomeSpan sketch to *sVer*, which can be any arbitrary character string