github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-09-11 23:37:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the runtime key methods instead of stubbing them

Browse Source
This commit is contained in:
J. Nick Koston
2026-09-05 17:42:12 +02:00
parent adc8671b2e
commit 4a292cb5ba
1 changed files with 2 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/api/api_server.h
+2 -11
View File
@@ -77,19 +77,10 @@ class APIServer final : public Component,
#ifdef USE_API_NOISE
#ifndef USE_API_NOISE_PSK_FROM_YAML
// Runtime key changes exist for the provisioning path only (not lambdas);
// with a yaml key they compile out
bool save_noise_psk(noise::psk_t psk, bool make_active = true);
bool clear_noise_psk(bool make_active = true);
#else
// Stubs so a lambda calling these with a yaml key gets a clear error; only
// fire if instantiated
template<bool B = false> bool save_noise_psk(noise::psk_t, bool = true) {
static_assert(B, "save_noise_psk() needs a runtime provisioned key; remove the 'key' from 'api: encryption:'");
return false;
}
template<bool B = false> bool clear_noise_psk(bool = true) {
static_assert(B, "clear_noise_psk() needs a runtime provisioned key; remove the 'key' from 'api: encryption:'");
return false;
}
#endif
/// psk points at 32 bytes that live in flash for the life of the program
void set_noise_psk(const uint8_t *psk) { this->noise_ctx_.set_psk(psk); }