Add state roles documentation to generated adapter templates

templates/README.md.ts

@@ -136,6 +136,9 @@ ${
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in \`package.json\`
 Several npm scripts are predefined for your convenience. You can run them using \`npm run <scriptname>\`
 | Script name | Description |

templates/main.js.ts

@@ -79,6 +79,11 @@ ${adapterSettings.map(s => `\t\tthis.log.debug(${quote}config ${s.key}: \${this.
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates(${quote}testVariable${quote});
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

templates/src/main.ts.ts

@@ -75,6 +75,11 @@ ${adapterSettings.map(s => `\t\tthis.log.debug(${quote}config ${s.key}: \${this.
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates(${quote}testVariable${quote});
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/ReleaseScript_JS/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/ReleaseScript_TS/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/TS_DoubleQuotes/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/TS_SingleQuotes/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates('testVariable');
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_JS_JsonUI_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_JS_JsonUI_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/main.js

@@ -55,6 +55,11 @@ class TestAdapter extends utils.Adapter {
             native: {},
         });
 
+        // **************************************************************************************************
+        // In order to use the correct role for state objects, please refer to the state roles documentation
+        // https://www.iobroker.net/#en/documentation/dev/stateroles.md
+        // **************************************************************************************************
+
         // In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
         this.subscribeStates('testVariable');
         // You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_JS_OfficialESLint/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_JS_OfficialESLint/main.js

@@ -55,6 +55,11 @@ class TestAdapter extends utils.Adapter {
             native: {},
         });
 
+        // **************************************************************************************************
+        // In order to use the correct role for state objects, please refer to the state roles documentation
+        // https://www.iobroker.net/#en/documentation/dev/stateroles.md
+        // **************************************************************************************************
+
         // In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
         this.subscribeStates('testVariable');
         // You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_JS_React/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_JS_React/main.js

@@ -55,6 +55,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_TS_ESLint_Tabs_DoubleQuotes_MIT/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_TS_ESLint_Tabs_DoubleQuotes_MIT/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_TS_OfficialESLint/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_TS_OfficialESLint/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_TS_React/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_TS_React/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_TS_React_OfficialESLint/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_TS_React_OfficialESLint/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."

test/baselines/adapter_TS_VIS_CustomESLint/README.md

@@ -49,6 +49,9 @@ You are almost done, only a few steps left:
 We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
 check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
 
+### State Roles
+When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |

test/baselines/adapter_TS_VIS_CustomESLint/src/main.ts

@@ -50,6 +50,11 @@ class TestAdapter extends utils.Adapter {
 			native: {},
 		});
 
+		// **************************************************************************************************
+		// In order to use the correct role for state objects, please refer to the state roles documentation
+		// https://www.iobroker.net/#en/documentation/dev/stateroles.md
+		// **************************************************************************************************
+
 		// In order to get state updates, you need to subscribe to them. The following line adds a subscription for our variable we have created above.
 		this.subscribeStates("testVariable");
 		// You can also add a subscription for multiple states. The following line watches all states starting with "lights."