Movensys.AlarmHelper.Core 1.0.1

Movensys.AlarmHelper.Core

This is a function for alarm developed by the Movensys Application Team.

Features

• Enum-based API – strongly-typed, zero magic strings
• Two operating modes (Manage each alarm code individually, Pack active alarms into a 16-bit word array for fast PLC transfer)
• CRUD helpers – Insert, Clear, AllClear, Contains, GetActiveAlarms, GetHistory
• Real-time events – AlarmInserted / AlarmCleared for UI binding or logging
• Json file support – manage alarm parameters and troubleshooting via external .json files

Quick Start

1 Define your enums

using Movensys.AlarmHelper.Core.Definitions;

enum AlarmCode
{
    OverHeat = 0,
    ServoError,
    LimitExceeded,
    SensorFail
}

enum AlarmLevel
{
    Warning,
    Error,
    Critical
}

2 Per‑code tracking with CodeAlarm

using Movensys.AlarmHelper.Core.AlarmTypes;

var alarm = new CodeAlarm<AlarmCode, AlarmLevel>();

// raise an alarm
alarm.Insert(AlarmCode.OverHeat);

// query
if (alarm.Contains(AlarmCode.OverHeat))
    Console.WriteLine("🔥 OverHeat active");

// clear
alarm.Clear(AlarmCode.OverHeat);

3 PLC‑friendly bitmap with WordAlarm

using Movensys.AlarmHelper.Core.AlarmTypes;

var plcAlarm = new WordAlarm<AlarmCode, AlarmLevel>();
plcAlarm.Insert(AlarmCode.SensorFail);

// build 16‑bit word array → send to PLC
ushort[] words = plcAlarm.GetWordArray();
PlcApi.WriteWords(0x1000, words);

4 Generic handling via BaseAlarm

BaseAlarm<AlarmCode, AlarmLevel> generic = new WordAlarm<AlarmCode, AlarmLevel>();

generic.Insert(AlarmCode.LimitExceeded);

// WordAlarm‑specific API when you really need it
if (generic is WordAlarm<AlarmCode, AlarmLevel> wa)
{
    ushort[] buf = wa.GetWordArray();
    /* … */
}

Tip

• Batch operations – call AllClear() before system start‑up to guarantee a clean slate.
• Cleared alarm history – After the application starts, call GetHistory() to review cleared alarm records.
• UI binding – subscribe to AlarmInserted / AlarmCleared and push updates to your MVVM ObservableCollection.
• Option strings – Use the Option string in AlarmParam to tag alarms with device‑specific directives (e.g., LED RED Blink) so your controller can run LED patterns when that option text appears in an active alarm.

Release History

may 30, 2025 - 1.0.1 ver<br> initial public release: CodeAlarm, WordAlarm, troubleshooting localization.<br>