@iobroker/create-adapter/build/templates/main.js.js

Command line utility to create customized ioBroker adapters

"use strict";
const questions_1 = require("../src/lib/core/questions");
const tools_1 = require("../src/lib/tools");
const templateFunction = async (answers) => {
    const useJavaScript = answers.language === "JavaScript";
    if (!useJavaScript) {
        return;
    }
    const className = (0, tools_1.kebabCaseToUpperCamelCase)(answers.adapterName);
    const adapterSettings = answers.adapterSettings || (0, questions_1.getDefaultAnswer)("adapterSettings");
    const quote = answers.quotes === "double" ? '"' : "'";
    const t = answers.indentation === "Space (4)" ? "    " : "\t";
    const template = `${quote}use strict${quote};

/*
 * Created with @iobroker/create-adapter v${answers.creatorVersion}
 */

// The adapter-core module gives you access to the core ioBroker functions
// you need to create an adapter
const utils = require(${quote}@iobroker/adapter-core${quote});

// Load your modules here, e.g.:
// const fs = require(${quote}fs${quote});

class ${className} extends utils.Adapter {
	/**
	 * @param {Partial<utils.AdapterOptions>} [options] - Adapter options
	 */
	constructor(options) {
		super({
			...options,
			name: ${quote}${answers.adapterName}${quote},
		});
		this.on(${quote}ready${quote}, this.onReady.bind(this));
		this.on(${quote}stateChange${quote}, this.onStateChange.bind(this));
		// this.on(${quote}objectChange${quote}, this.onObjectChange.bind(this));
		// this.on(${quote}message${quote}, this.onMessage.bind(this));
		this.on(${quote}unload${quote}, this.onUnload.bind(this));
	}

	/**
	 * Is called when databases are connected and adapter received configuration.
	 */
	async onReady() {
		// Initialize your adapter here

${answers.connectionIndicator === "yes"
        ? `
		// Reset the connection indicator during startup
		this.setState(${quote}info.connection${quote}, false, true);
`
        : ""}

		// The adapters config (in the instance object everything under the attribute "native") is accessible via
		// this.config:
${adapterSettings.map(s => `\t\tthis.log.debug(${quote}config ${s.key}: \${this.config.${s.key}}${quote});`).join("\n")}

		/*
		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},
			common: {
				name: ${quote}testVariable${quote},
				type: ${quote}boolean${quote},
				role: ${quote}indicator${quote},
				read: true,
				write: true,
			},
			native: {},
		});

		// 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."
		// this.subscribeStates(${quote}lights.*${quote});
		// Or, if you really must, you can also watch all states. Don't do this if you don't need to. Otherwise this will cause a lot of unnecessary load on the system:
		// this.subscribeStates(${quote}*${quote});

		/*
			setState examples
			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)
		await this.setState(${quote}testVariable${quote}, 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
		await this.setState(${quote}testVariable${quote}, { val: true, ack: true });

		// same thing, but the state is deleted after 30s (getState will return null afterwards)
		await this.setState(${quote}testVariable${quote}, { val: true, ack: true, expire: 30 });

		// examples for the checkPassword/checkGroup functions
		const pwdResult = await this.checkPasswordAsync(${quote}admin${quote}, ${quote}iobroker${quote});
		this.log.info(\`check user admin pw iobroker: \${pwdResult}\`);

		const groupResult = await this.checkGroupAsync(${quote}admin${quote}, ${quote}admin${quote});
		this.log.info(\`check group user admin group admin: \${groupResult}\`);
	}

	/**
	 * Is called when adapter shuts down - callback has to be called under any circumstances!
	 *
	 * @param {() => void} callback - Callback function
	 */
	onUnload(callback) {
		try {
			// Here you must clear all timeouts or intervals that may still be active
			// clearTimeout(timeout1);
			// clearTimeout(timeout2);
			// ...
			// clearInterval(interval1);

			callback();
		} catch (error) {
			this.log.error(\`Error during unloading: \${error.message}\`);
			callback();
		}
	}

	// If you need to react to object changes, uncomment the following block and the corresponding line in the constructor.
	// You also need to subscribe to the objects with \`this.subscribeObjects\`, similar to \`this.subscribeStates\`.
	// /**
	//  * Is called if a subscribed object changes
	//  * @param {string} id
	//  * @param {ioBroker.Object | null | undefined} obj
	//  */
	// onObjectChange(id, obj) {
	// ${t}if (obj) {
	// ${t}${t}// The object was changed
	// ${t}${t}this.log.info(\`object \${id} changed: \${JSON.stringify(obj)}\`);
	// ${t}} else {
	// ${t}${t}// The object was deleted
	// ${t}${t}this.log.info(\`object \${id} deleted\`);
	// ${t}}
	// }

	/**
	 * Is called if a subscribed state changes
	 *
	 * @param {string} id - State ID
	 * @param {ioBroker.State | null | undefined} state - State object
	 */
	onStateChange(id, state) {
		if (state) {
			// The state was changed
			this.log.info(\`state \${id} changed: \${state.val} (ack = \${state.ack})\`);

			if (state.ack === false) {
				// This is a command from the user (e.g., from the UI or other adapter)
				// and should be processed by the adapter
				this.log.info(\`User command received for \${id}: \${state.val}\`);

				// TODO: Add your control logic here
			}
		} else {
			// The object was deleted or the state value has expired
			this.log.info(\`state \${id} deleted\`);
		}
	}
	// If you need to accept messages in your adapter, uncomment the following block and the corresponding line in the constructor.
	// /**
	//  * Some message was sent to this instance over message box. Used by email, pushover, text2speech, ...
	//  * Using this method requires "common.messagebox" property to be set to true in io-package.json
	//  * @param {ioBroker.Message} obj
	//  */
	// onMessage(obj) {
	// ${t}if (typeof obj === ${quote}object${quote} && obj.message) {
	// ${t}${t}if (obj.command === ${quote}send${quote}) {
	// ${t}${t}${t}// e.g. send email or pushover or whatever
	// ${t}${t}${t}this.log.info(${quote}send command${quote});

	// ${t}${t}${t}// Send response in callback if required
	// ${t}${t}${t}if (obj.callback) this.sendTo(obj.from, obj.command, ${quote}Message received${quote}, obj.callback);
	// ${t}${t}}
	// ${t}}
	// }
}

if (require.main !== module) {
	// Export the constructor in compact mode
	/**
	 * @param {Partial<utils.AdapterOptions>} [options] - Adapter options
	 */
	module.exports = options => new ${className}(options);
} else {
	// otherwise start the instance directly
	new ${className}();
}
`;
    return template;
};
templateFunction.customPath = "main.js";
module.exports = templateFunction;
//# sourceMappingURL=main.js.js.map