Update docs for the state_listener_manager API.

This commit is contained in:
2025-02-14 15:12:37 +03:00
parent 069363205a
commit feb1f4ac81
2 changed files with 10 additions and 5 deletions

View File

@@ -63,9 +63,12 @@ typedef enum relay_chn_state_enum relay_chn_state_t;
/**
* @brief Relay channel state change listener.
*
*
* An optional interface to listen to the channel state change events.
*
* The listeners SHOULD be implemented as light functions and SHOULD NOT contain
* any blocking calls. Otherwise the relay_chn module would not function properly
* since it is designed as event driven.
*
* @param chn_id The ID of the channel whose state has changed.
* @param old_state The old state of the channel.
* @param new_state The new state of the channel.