1616public interface AccessoryWithFanState {
1717
1818 /**
19- * OPTIONAL: Retrieves the current state of the fan (INACTIVE, IDLE, BLOWING AIR).
19+ * Retrieves the current state of the fan (INACTIVE, IDLE, BLOWING AIR).
2020 *
2121 * @return a future that will contain the state
2222 */
2323 CompletableFuture <CurrentFanStateEnum > getCurrentFanState ();
2424
2525 /**
26- * OPTIONAL: Retrieves the target state of the fan (MANUAL, AUTO).
26+ * Retrieves the target state of the fan (MANUAL, AUTO).
2727 *
2828 * @return a future that will contain the state
2929 */
3030 CompletableFuture <TargetFanStateEnum > getTargetFanState ();
3131
3232 /**
33- * OPTIONAL: Set the target state of the fan (MANUAL, AUTO).
33+ * Set the target state of the fan (MANUAL, AUTO).
3434 *
3535 * @param targetState target state
36+ * @return a future that completes when the change is made
3637 */
3738 CompletableFuture <Void > setTargetFanState (TargetFanStateEnum targetState );
3839
3940 /**
40- * OPTIONAL: Retrieves the swing mode of the fan.
41+ * Retrieves the swing mode of the fan.
4142 *
4243 * @return a future that will contain the swing mode
4344 */
4445 CompletableFuture <SwingModeEnum > getSwingMode ();
4546
4647 /**
47- * OPTIONAL: Set the swing mode of the fan (DISABLED, ENABLED).
48+ * Set the swing mode of the fan (DISABLED, ENABLED).
4849 *
4950 * @param swingMode swing mode
51+ * @return a future that completes when the change is made
5052 */
5153 CompletableFuture <Void > setSwingMode (SwingModeEnum swingMode );
5254
@@ -58,28 +60,29 @@ public interface AccessoryWithFanState {
5860 CompletableFuture <LockPhysicalControlsEnum > getLockControls ();
5961
6062 /**
61- * OPTIONAL: Set the lock controls of the fan (DISABLED, ENABLED).
63+ * Set the lock controls of the fan (DISABLED, ENABLED).
6264 *
6365 * @param lockControls lock controls mode
66+ * @return a future that completes when the change is made
6467 */
6568 CompletableFuture <Void > setLockControls (LockPhysicalControlsEnum lockControls );
6669
6770 /**
68- * OPTIONAL: Retrieves the current rotation direction of the fan.
71+ * Retrieves the current rotation direction of the fan.
6972 *
7073 * @return a future that will contain the direction
7174 */
7275 CompletableFuture <RotationDirectionEnum > getRotationDirection ();
7376
7477 /**
75- * OPTIONAL: Retrieves the current speed of the fan's rotation
78+ * Retrieves the current speed of the fan's rotation
7679 *
7780 * @return a future that will contain the speed, expressed as an integer between 0 and 100.
7881 */
7982 CompletableFuture <Integer > getRotationSpeed ();
8083
8184 /**
82- * OPTIONAL: Sets the rotation direction of the fan
85+ * Sets the rotation direction of the fan
8386 *
8487 * @param direction the direction to set
8588 * @return a future that completes when the change is made
@@ -97,62 +100,62 @@ public interface AccessoryWithFanState {
97100 CompletableFuture <Void > setRotationSpeed (Integer speed ) throws Exception ;
98101
99102 /**
100- * OPTIONAL: Subscribes to changes in the rotation direction of the fan.
103+ * Subscribes to changes in the rotation direction of the fan.
101104 *
102105 * @param callback the function to call when the direction changes.
103106 */
104107 void subscribeRotationDirection (HomekitCharacteristicChangeCallback callback );
105108
106109 /**
107- * OPTIONAL: Subscribes to changes in the current fan state.
110+ * Subscribes to changes in the current fan state.
108111 *
109112 * @param callback the function to call when the direction changes.
110113 */
111114 void subscribeCurrentFanState (HomekitCharacteristicChangeCallback callback );
112115
113116 /**
114- * OPTIONAL: Subscribes to changes in the target fan state.
117+ * Subscribes to changes in the target fan state.
115118 *
116119 * @param callback the function to call when the direction changes.
117120 */
118121 void subscribeTargetFanState (HomekitCharacteristicChangeCallback callback );
119122
120123 /**
121- * OPTIONAL: Subscribes to changes in the rotation speed of the fan.
124+ * Subscribes to changes in the rotation speed of the fan.
122125 *
123126 * @param callback the function to call when the speed changes.
124127 */
125128 void subscribeRotationSpeed (HomekitCharacteristicChangeCallback callback );
126129
127130 /**
128- * OPTIONAL: Subscribes to changes in the swing mode of the fan.
131+ * Subscribes to changes in the swing mode of the fan.
129132 *
130133 * @param callback the function to call when the swing mode changes.
131134 */
132135 void subscribeSwingMode (HomekitCharacteristicChangeCallback callback );
133136
134137 /**
135- * OPTIONAL: Subscribes to changes in the lock controls of the fan.
138+ * Subscribes to changes in the lock controls of the fan.
136139 *
137140 * @param callback the function to call when the lock controls changes.
138141 */
139142 void subscribeLockControls (HomekitCharacteristicChangeCallback callback );
140143
141- /** OPTIONAL: Unsubscribes from changes in the rotation direction of the fan. */
144+ /** Unsubscribes from changes in the rotation direction of the fan. */
142145 void unsubscribeRotationDirection ();
143146
144- /** OPTIONAL: Unsubscribes from changes in the fan's rotation speed. */
147+ /** Unsubscribes from changes in the fan's rotation speed. */
145148 void unsubscribeRotationSpeed ();
146149
147- /** OPTIONAL: Unsubscribes from changes in the current state of the fan. */
150+ /** Unsubscribes from changes in the current state of the fan. */
148151 void unsubscribeCurrentFanState ();
149152
150- /** OPTIONAL: Unsubscribes from changes in the target state of the fan. */
153+ /** Unsubscribes from changes in the target state of the fan. */
151154 void unsubscribeTargetFanState ();
152155
153- /** OPTIONAL: Unsubscribes from changes in the swing mode of the fan. */
156+ /** Unsubscribes from changes in the swing mode of the fan. */
154157 void unsubscribeSwingMode ();
155158
156- /** OPTIONAL: Unsubscribes from changes in the lock controls of the fan. */
159+ /** Unsubscribes from changes in the lock controls of the fan. */
157160 void unsubscribeLockControls ();
158161}
0 commit comments