Skip to content

Update RangeController.h documentation #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Update RangeController.h documentation #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Capabilities/RangeController.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ void RangeController<T>::onAdjustRangeValue(const String &instance, GenericAdjus
/**
* @brief Send `rangeValue` event to report curent rangeValue to SinricPro server
*
* @param rangeValue Value between 0..3
* @param rangeValue value for the range.
* @param cause (optional) `String` reason why event is sent (default = `"PHYSICAL_INTERACTION"`)
* @return the success of sending the even
* @retval true event has been sent successfully
Expand All @@ -215,7 +215,7 @@ bool RangeController<T>::sendRangeValueEvent(int rangeValue, String cause) {
* @brief Send `rangeValue` event to report curent rangeValue to SinricPro server for a specific instance (custom device)
*
* @param instance String instance name
* @param rangeValue Value between 0..3
* @param rangeValue value for the range
* @param cause (optional) `String` reason why event is sent (default = `"PHYSICAL_INTERACTION"`)
* @return the success of sending the even
* @retval true event has been sent successfully
Expand Down Expand Up @@ -323,4 +323,4 @@ bool RangeController<T>::handleRangeController(SinricProRequest &request) {
} // SINRICPRO_NAMESPACE

template <typename T>
using RangeController = SINRICPRO_NAMESPACE::RangeController<T>;
using RangeController = SINRICPRO_NAMESPACE::RangeController<T>;