PSAwtrixNG.psd1
|
# # Module manifest for module 'PSAwtrixNG' # # Generated by: Gael Colas # # Generated on: 10.09.2026 # @{ # Script module or binary module file associated with this manifest. RootModule = 'PSAwtrixNG.psm1' # Version number of this module. ModuleVersion = '0.2.0' # Supported PSEditions CompatiblePSEditions = @('Desktop', 'Core') # ID used to uniquely identify this module GUID = 'ba9587f1-a84d-494e-aa1c-444d9f508474' # Author of this module Author = 'Gael Colas' # Company or vendor of this module CompanyName = 'SynEdgy' # Copyright statement for this module Copyright = '(c) 2026 Gael Colas. Licensed under the MIT License.' # Description of the functionality provided by this module Description = 'PowerShell module for managing and automating AWTRIX NG devices.' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. DotNetFrameworkVersion = '4.6.1' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # ClrVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = @('Disable-AwtrixAppRotation','Enable-AwtrixAppRotation','Remove-AwtrixPushedApp','Set-AwtrixPushedApp','Get-AwtrixFile','Get-AwtrixStorage','Get-AwtrixIcon','Remove-AwtrixIcon','Save-AwtrixIcon','Set-AwtrixIcon','Get-AwtrixMqttBroker','Publish-AwtrixMqttMessage','Receive-AwtrixMqttMessage','Start-AwtrixMqttBroker','Stop-AwtrixMqttBroker','Get-AwtrixScript','Get-AwtrixScriptConfiguration','Install-AwtrixStopwatch','Remove-AwtrixScript','Set-AwtrixScript','Set-AwtrixScriptConfiguration','Clear-AwtrixIndicator','Disable-AwtrixDisplay','Enable-AwtrixDisplay','Get-AwtrixApp','Get-AwtrixBrightness','Get-AwtrixCapability','Get-AwtrixDisplay','Get-AwtrixScreen','Get-AwtrixSettings','Get-AwtrixStatus','Invoke-AwtrixApi','New-AwtrixDevice','Remove-AwtrixNotification','Select-AwtrixApp','Send-AwtrixNotification','Set-AwtrixBrightness','Set-AwtrixIndicator','Set-AwtrixSetting','Show-AwtrixScreen','Update-AwtrixFirmware','Watch-AwtrixScreen') # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = @() # DSC resources to export from this module DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = @('AWTRIX', 'AWTRIXNG', 'Ulanzi', 'ESP32', 'MQTT', 'IoT') # A URL to the license for this module. LicenseUri = 'https://github.com/SynEdgy/PSAwtrixNG/blob/main/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/SynEdgy/PSAwtrixNG' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '## [0.2.0-preview0003] - 2026-10-11 ### Added - AWTRIX NG `/api/v1` device, settings, display, screen, app, notification, indicator, and capability commands. - NG-native pushed-app commands without AWTRIX 3 compatibility aliases. - Dynamic terminal rendering for the dimensions reported by the device. - Berry script upload, download, configuration, and removal commands. - An on-device stopwatch with select-button start/pause, a three-press local reset sequence, hundredths-of-a-second display, and optional MQTT reset/state topics. - MQTT stopwatch control commands for idempotent start and pause, plus toggle, reset, and restart. - An end-to-end MQTT stopwatch walkthrough covering the PowerShell broker, AWTRIX NG system configuration, reboot, app selection, control commands, and captured state messages. - GIF and JPEG icon upload, listing, ID resolution, download, and removal commands, including device storage preflight and upload verification. - `Get-AwtrixStorage` for total, used, and free shared filesystem capacity. - Commands to disable and enable automatic app-to-app rotation. - `Set-AwtrixBrightness` with absolute 0–100 percentages and constrained relative increase or decrease adjustments. - `Get-AwtrixBrightness` with normalized percentage, native firmware value, and automatic-brightness state. - Typed `AwtrixApp`, `AwtrixNotification`, and `AwtrixScroll` payload classes with bare and module-qualified type accelerators and canonical JSON property casing. - Bundled static and animated GIF assets copied into the packaged module for use in notifications and pushed-app cards, including white terminal and compact PowerShell icons. - `Get-AwtrixFile` for Get-ChildItem-style listing of the ICONS, MELODIES, PALETTES, and MP3 asset directories. - An in-process MQTTnet broker with PowerShell 5.1 and PowerShell 7 assets. - `Update-AwtrixFirmware` for guarded multipart OTA installation with explicit opt-in, high-impact confirmation, and local image checks before the device performs its complete firmware validation. ### Changed - Renamed the module and all associated types, assemblies, documentation, and build artifacts from `synedgy.PSAwtrixNG` to `PSAwtrixNG`. - Changed the on-device stopwatch to cache paused display text and perform high-frequency elapsed-time formatting only while the timer is running. - Moved the Stopwatch Berry implementation into a packaged `Berry/Stopwatch` application directory with explicit template tokens, allowing installation commands to load scripts and associated assets without embedded PowerShell here-strings. - Added declarative length validation for icon file names and their firmware-facing IDs. - Corrected the bundled Minecraft icon filenames and changed their canvases from 32×8 backgrounds to 8×8 side icons. - Changed `terminal-white.gif` from a 32x8 background to an 8x8 side icon so pushed-app text uses the remaining display width. ' # Prerelease string of this module Prerelease = 'preview0003' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false # External dependent modules of this module # ExternalModuleDependencies = @() } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |