NewModule

1 Minute

0 Likes

25 Views

Starter Control module template for creating a new PIXERA module.

NewModule provides the standard module lifecycle structure, including reference forwarding, initialization locking, helper loading, property loading, and clean uninitialization. It is intended as a base module that can be customized with additional libraries, properties, actions, drivers, tickers, schedulers, or device-specific logic.

Usage

Use NewModule as the starting point for a custom Control module.

The module includes the common init and uninit lifecycle actions and a ref action for forwarding calls through the node system. The Description property should be updated to describe the finished module's purpose, functionality, configuration, and operational notes.

For a step-by-step introduction to creating modules, see How to Build a Module From Scratch.

Features

NewModule already includes the basic structure commonly needed by a new module:

ref returns self() so action calls can be forwarded through connected module references.
init blocks overlapping asynchronous initialization calls with self.lockInit.
init calls uninit first when the module is already initialized.
init loads pixcHelper and creates self.helper for helper functions such as property access and logging.
init loads all configured properties into self.properties with self.helper:loadAllProperties().
init contains a marked section for custom startup logic.
uninit clears helper and property references and resets the initialized and init-lock states.
uninit contains a marked section for unloading variables, tickers, schedulers, drivers, connections, or other runtime resources.

The existing init lock prevents overlapping asynchronous initialization calls. If init is called while the module is already initialized, it calls uninit first and then continues with initialization.

Data

Actions

Action	Info	Input	Output
ref	Returns a reference to the module instance for forwarding action calls by name through the node system.	-	self
init	Initializes the module, prevents overlapping init calls, unloads an existing initialization if needed, loads the PIXERA helper, loads all properties into `self.properties`, and sets the initialized state.	-	-
uninit	Unloads helper and property references and resets the initialized and init-lock states. Extend this action to disable custom runtime resources.	-	-

Properties

Name	Content	Type Hint
Auto Init	true	bool
Description	Enter a description for this Module. Use this field to provide information about its purpose, functionality, configuration, or any relevant operational notes. This description helps users understand how and when the Module should be used.
Author	AV Stumpfl GmbH	string
Logo	Embedded image in module JSON	image
Url	https://help.pixera.one	url
Version	1.0	string

Changelog

_{Module Version 1.1 | 9 July 2026 | AV Stumpfl GmbH}

CATEGORIES

IN THIS ARTICLE

RELATED GUIDES

Whoops…Nothing found