Fix setState calls to be properly awaited - setState returns Promise when called without callback

Co-authored-by: Apollon77 <11976694+Apollon77@users.noreply.github.com>

Author: Copilot

docs/updates/20250831_setstate_sync.md

@@ -1,14 +1,14 @@
 # Replace deprecated setStateAsync with setState
 
-The `setStateAsync` method has been deprecated in favor of the synchronous `setState` method. Newly created adapters will now use the current recommended API. If you have an existing adapter using `setStateAsync`, you should update it to use `setState` instead.
+The `setStateAsync` method has been deprecated in favor of the `setState` method. Newly created adapters will now use the current recommended API. If you have an existing adapter using `setStateAsync`, you should update it to use `setState` instead.
 
 ## What changed
 
-The adapter template generation was updated to use `this.setState()` instead of `await this.setStateAsync()` for setting states.
+The adapter template generation was updated to use `await this.setState()` instead of `await this.setStateAsync()` for setting states.
 
 ## Manual migration for existing adapters
 
-If you have an existing adapter that uses `setStateAsync`, you should replace all occurrences with the synchronous `setState` method:
+If you have an existing adapter that uses `setStateAsync`, you should replace all occurrences with the `setState` method:
 
 ```diff
 // Before (deprecated)
@@ -17,18 +17,18 @@ If you have an existing adapter that uses `setStateAsync`, you should replace al
 - await this.setStateAsync("testVariable", { val: true, ack: true, expire: 30 });
 
 // After (current)
-+ this.setState("testVariable", true);
-+ this.setState("testVariable", { val: true, ack: true });
-+ this.setState("testVariable", { val: true, ack: true, expire: 30 });
++ await this.setState("testVariable", true);
++ await this.setState("testVariable", { val: true, ack: true });
++ await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 ```
 
 ## Why this change
 
-The `setStateAsync` method was deprecated because:
-- `setState` is now synchronous and doesn't return a Promise
-- Using the synchronous version is simpler and more efficient
-- It aligns with current ioBroker adapter development best practices
+The `setStateAsync` method was deprecated in favor of the simpler `setState` method:
+- `setState` when called without a callback returns a Promise and should be awaited
+- `setState` when called with a callback is synchronous
+- Using `setState` aligns with current ioBroker adapter development best practices
 
 ## No functional changes
 
-This change does not affect the functionality of your adapter - both methods perform the same operation. The only difference is that `setState` is synchronous and doesn't need to be awaited.
+This change does not affect the functionality of your adapter - both methods perform the same operation. The only difference is using the current recommended API instead of the deprecated one.

templates/main.js.ts

@@ -87,14 +87,14 @@ ${adapterSettings.map(s => `\t\tthis.log.info("config ${s.key}: " + this.config.
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

templates/src/main.ts.ts

@@ -83,14 +83,14 @@ ${adapterSettings.map(s => `\t\tthis.log.info("config ${s.key}: " + this.config.
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

test/baselines/TS_SingleQuotes/src/main.ts

@@ -63,14 +63,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState('testVariable', true);
+		await this.setState('testVariable', true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState('testVariable', { val: true, ack: true });
+		await this.setState('testVariable', { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState('testVariable', { val: true, ack: true, expire: 30 });
+		await this.setState('testVariable', { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync('admin', 'iobroker');

test/baselines/adapter_JS_JsonUI_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/main.js

@@ -68,14 +68,14 @@ class TestAdapter extends utils.Adapter {
             you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
         */
         // the variable testVariable is set to true as command (ack=false)
-        this.setState('testVariable', true);
+        await this.setState('testVariable', true);
 
         // same thing, but the value is flagged "ack"
         // ack should be always set to true if the value is received from or acknowledged from the target system
-        this.setState('testVariable', { val: true, ack: true });
+        await this.setState('testVariable', { val: true, ack: true });
 
         // same thing, but the state is deleted after 30s (getState will return null afterwards)
-        this.setState('testVariable', { val: true, ack: true, expire: 30 });
+        await this.setState('testVariable', { val: true, ack: true, expire: 30 });
 
         // examples for the checkPassword/checkGroup functions
         const pwdResult = await this.checkPasswordAsync('admin', 'iobroker');

test/baselines/adapter_JS_React/main.js

@@ -68,14 +68,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

test/baselines/adapter_TS_ESLint_Tabs_DoubleQuotes_MIT/src/main.ts

@@ -63,14 +63,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

test/baselines/adapter_TS_React/src/main.ts

@@ -63,14 +63,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

test/baselines/connectionIndicator_yes/src/main.ts

@@ -66,14 +66,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");

test/baselines/customAdapterSettings/src/main.ts

@@ -63,14 +63,14 @@ class TestAdapter extends utils.Adapter {
 			you will notice that each setState will cause the stateChange event to fire (because of above subscribeStates cmd)
 		*/
 		// the variable testVariable is set to true as command (ack=false)
-		this.setState("testVariable", true);
+		await this.setState("testVariable", true);
 
 		// same thing, but the value is flagged "ack"
 		// ack should be always set to true if the value is received from or acknowledged from the target system
-		this.setState("testVariable", { val: true, ack: true });
+		await this.setState("testVariable", { val: true, ack: true });
 
 		// same thing, but the state is deleted after 30s (getState will return null afterwards)
-		this.setState("testVariable", { val: true, ack: true, expire: 30 });
+		await this.setState("testVariable", { val: true, ack: true, expire: 30 });
 
 		// examples for the checkPassword/checkGroup functions
 		const pwdResult = await this.checkPasswordAsync("admin", "iobroker");