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.

Setup

1. Add NewModule to the project and rename it for its intended purpose.
2. Update the Description, Author, Documentation, and Version properties where required.
3. Add configuration properties and actions for the new module.
4. Add startup code to init and the corresponding cleanup code to uninit.
5. Run init manually or enable Auto Init.

Keep the code that resets self.isInit and self.lockInit at the end of uninit so the module can recover from an interrupted initialization.

Features

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

1. ref returns self() so action calls can be forwarded through connected module references.
2. init blocks overlapping asynchronous initialization calls with self.lockInit.
3. init calls uninit first when the module is already initialized.
4. init loads pixcHelper and creates self.helper for helper functions such as property access and logging.
5. init loads all configured properties into self.properties with self.helper:loadAllProperties().
6. init contains a marked section for custom startup logic.
7. uninit clears helper and property references and resets the initialized and init-lock states.
8. 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.

Actions

Properties

Changelog

• 1.2
• Corrected the internal action paths to use the NewModule name.
• Updated the initialization code to follow the current Lua formatting standard.
• Added the explicit string type to the Description property.