Add state roles documentation to generated adapter templates

templates/README.md.ts

@@ -136,6 +136,11 @@ ${
 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -66,6 +66,10 @@ ${adapterSettings.map(s => `\t\tthis.log.debug(${quote}config ${s.key}: \${this.
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync(${quote}testVariable${quote}, {
 			type: ${quote}state${quote},

templates/src/main.ts.ts

@@ -62,6 +62,10 @@ ${adapterSettings.map(s => `\t\tthis.log.debug(${quote}config ${s.key}: \${this.
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync(${quote}testVariable${quote}, {
 			type: ${quote}state${quote},

test/baselines/ReleaseScript_JS/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/TS_SingleQuotes/src/main.ts

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync('testVariable', {
 			type: 'state',

test/baselines/adapter_JS_JsonUI_ESLint_TypeChecking_Spaces_SingleQuotes_Apache-2.0/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -42,6 +42,10 @@ class TestAdapter extends utils.Adapter {
         For every state in the system there has to be also an object of type state
         Here a simple template for a boolean variable named "testVariable"
         Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+        IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+                   Please refer to the state roles documentation for guidance:
+                   https://www.iobroker.net/#en/documentation/dev/stateroles.md
         */
         await this.setObjectNotExistsAsync('testVariable', {
             type: 'state',

test/baselines/adapter_JS_OfficialESLint/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -42,6 +42,10 @@ class TestAdapter extends utils.Adapter {
         For every state in the system there has to be also an object of type state
         Here a simple template for a boolean variable named "testVariable"
         Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+        IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+                   Please refer to the state roles documentation for guidance:
+                   https://www.iobroker.net/#en/documentation/dev/stateroles.md
         */
         await this.setObjectNotExistsAsync('testVariable', {
             type: 'state',

test/baselines/adapter_JS_React/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -42,6 +42,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/adapter_TS_ESLint_Tabs_DoubleQuotes_MIT/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/adapter_TS_OfficialESLint/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/adapter_TS_React/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/adapter_TS_React_OfficialESLint/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### 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

@@ -37,6 +37,10 @@ class TestAdapter extends utils.Adapter {
 		For every state in the system there has to be also an object of type state
 		Here a simple template for a boolean variable named "testVariable"
 		Because every adapter instance uses its own unique namespace variable names can't collide with other adapters variables
+
+		IMPORTANT: State roles should be chosen carefully based on the state's purpose.
+		           Please refer to the state roles documentation for guidance:
+		           https://www.iobroker.net/#en/documentation/dev/stateroles.md
 		*/
 		await this.setObjectNotExistsAsync("testVariable", {
 			type: "state",

test/baselines/adapter_TS_VIS_CustomESLint/README.md

@@ -49,6 +49,11 @@ 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).
+
+**Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
+
 ### Scripts in `package.json`
 Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
 | Script name | Description |