client/src/app/_models/script.ts - master - tisit/FUXA_SCADA

client/src/app/_models/script.ts
345 строк10 KB
Umberto Nocelli
feat: add $getObject function to call from frontend script (#2015)
09 ноя 2025, 20:11
09 ноя 2025, 20:11bf44d4a

export class Script {
    id: string;
    name: string;
    code: string;
    sync?: boolean = false;
    parameters: ScriptParam[] = [];
    scheduling: ScriptScheduling;
    permission: number;
    permissionRoles: {
        enabled: string[];
    };
    mode: ScriptMode = ScriptMode.SERVER;
    constructor(_id: string) {
        this.id = _id;
    }
}

export class ScriptTest extends Script {
    test = true;
    outputId: string;           // to filter the console output sended from backend script runner

    constructor(_id: string, _name: string) {
        super(_id);
        this.name = _name;
    }
}

export class ScriptParam {
    name: string;
    type: ScriptParamType;
    value: any;

    constructor(_name: string, _type: ScriptParamType) {
        this.name = _name;
        this.type = _type;
    }
}

export enum ScriptParamType {
    tagid = 'tagid',
    value = 'value',
    chart = 'chart'
}

export const SCRIPT_PREFIX = 's_';
export const SCRIPT_PARAMS_MAP = 'params';

export interface ScriptConsoleMessage {
    msg: string;
    type: string;
    id: string;
}

export interface ScriptScheduling {
    mode: ScriptSchedulingMode;
    interval: number;
    schedules: SchedulerData[];
}

export interface SchedulerData {
    date?: Date;
    days?: any[];
    time?: string;
    hour?: number;
    minute?: number;
    type?: SchedulerType;
}

export enum ScriptSchedulingMode {
    interval = 'interval',
    start = 'start',
    scheduling = 'scheduling',
}

export enum SchedulerType {
    weekly = 0,
    date = 1,
}

export class SystemFunctions {
    functions: SystemFunction[] = [];

    constructor(mode?: ScriptMode) {
        this.functions = this.allFunctions.filter(sf => !sf.mode || !mode || sf.mode === mode);
    }

    allFunctions = <SystemFunction[]>[{
        name: '$setTag',
        mode: null,
        text: 'script.sys-fnc-settag-text',
        tooltip: 'script.sys-fnc-settag-tooltip',
        params: [true, false]
    },
    {
        name: '$getTag',
        mode: null,
        text: 'script.sys-fnc-gettag-text',
        tooltip: 'script.sys-fnc-gettag-tooltip',
        params: [true]
    },
    {
        name: '$getTagId',
        mode: null,
        text: 'script.sys-fnc-getTagId-text',
        tooltip: 'script.sys-fnc-getTagId-tooltip',
        params: [false],
        paramsText: 'script.sys-fnc-getTagId-params'
    },
    {
        name: '$getTagDaqSettings',
        mode: null,
        text: 'script.sys-fnc-getTagDaqSettings-text',
        tooltip: 'script.sys-fnc-getTagDaqSettings-tooltip',
        params: [true],
        paramsText: 'script.sys-fnc-getTagDaqSettings-params'
    },
    {
        name: '$setTagDaqSettings',
        mode: null,
        text: 'script.sys-fnc-setTagDaqSettings-text',
        tooltip: 'script.sys-fnc-setTagDaqSettings-tooltip',
        params: [true, false],
        paramsText: 'script.sys-fnc-setTagDaqSettings-params'
    },
    {
        name: '$setView',
        mode: null,
        text: 'script.sys-fnc-setview-text',
        tooltip: 'script.sys-fnc-setview-tooltip',
        params: [false],
        paramsText: 'script.sys-fnc-setview-params'
    },
    {
        name: '$openCard',
        mode: null,
        text: 'script.sys-fnc-opencard-text',
        tooltip: 'script.sys-fnc-opencard-tooltip',
        params: [false],
        paramsText: 'script.sys-fnc-opencard-params'
    },
    {
        name: '$enableDevice',
        mode: null,
        text: 'script.sys-fnc-enableDevice-text',
        tooltip: 'script.sys-fnc-enableDevice-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-enableDevice-params'
    },
    {
        name: '$getDeviceProperty',
        mode: null,
        text: 'script.sys-fnc-getDeviceProperty-text',
        tooltip: 'script.sys-fnc-getDeviceProperty-tooltip',
        params: [false],
        paramsText: 'script.sys-fnc-getDeviceProperty-params'
    },
    {
        name: '$setDeviceProperty',
        mode: null,
        text: 'script.sys-fnc-setDeviceProperty-text',
        tooltip: 'script.sys-fnc-setDeviceProperty-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-setDeviceProperty-params'
    },
    {
        name: '$getDevice',
        mode: ScriptMode.SERVER,
        text: 'script.sys-fnc-getDevice-text',
        tooltip: 'script.sys-fnc-getDevice-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-getDevice-params'
    },
    {
        name: '$setAdapterToDevice',
        mode: ScriptMode.CLIENT,
        text: 'script.sys-fnc-setAdapterToDevice-text',
        tooltip: 'script.sys-fnc-setAdapterToDevice-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-setAdapterToDevice-params'
    },
    {
        name: '$resolveAdapterTagId',
        mode: ScriptMode.CLIENT,
        text: 'script.sys-fnc-resolveAdapterTagId-text',
        tooltip: 'script.sys-fnc-resolveAdapterTagId-tooltip',
        params: [true],
        paramsText: 'script.sys-fnc-resolveAdapterTagId-params'
    },
    {
        name: '$invokeObject',
        mode: ScriptMode.CLIENT,
        text: 'script.sys-fnc-invokeObject-text',
        tooltip: 'script.sys-fnc-invokeObject-tooltip',
        params: [false, false, false],
        paramsText: 'script.sys-fnc-invokeObject-params'
    },
    {
        name: '$getObject',
        mode: ScriptMode.CLIENT,
        text: 'script.sys-fnc-getObject-text',
        tooltip: 'script.sys-fnc-getObject-tooltip',
        params: [false],
        paramsText: 'script.sys-fnc-getObject-params'
    },
    {
        name: '$runServerScript',
        mode: ScriptMode.CLIENT,
        text: 'script.sys-fnc-runServerScript-text',
        tooltip: 'script.sys-fnc-runServerScript-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-runServerScript-params'
    },
    {
        name: '$getHistoricalTags',
        mode: null,
        text: 'script.sys-fnc-getHistoricalTag-text',
        tooltip:'script.sys-fnc-getHistoricalTag-tooltip',
        params:['array', false, false],
        paramsText: 'script.sys-fnc-getHistoricalTag-params',
        paramFilter: ScriptParamFilterType.history
    },
    {
        name: '$sendMessage',
        mode: null,
        text: 'script.sys-fnc-sendMessage-text',
        tooltip: 'script.sys-fnc-sendMessage-tooltip',
        params: [false, false, false],
        paramsText: 'script.sys-fnc-sendMessage-params'
    },
    {
        name: '$getAlarms',
        mode: null,
        text: 'script.sys-fnc-getAlarms-text',
        tooltip: 'script.sys-fnc-getAlarms-tooltip',
        params: [],
        paramsText: 'script.sys-fnc-getAlarms-params'
    },
    {
        name: '$getAlarmsHistory',
        mode: null,
        text: 'script.sys-fnc-getAlarmsHistory-text',
        tooltip: 'script.sys-fnc-getAlarmsHistory-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-getAlarmsHistory-params'
    },
    {
        name: '$ackAlarm',
        mode: null,
        text: 'script.sys-fnc-ackAlarms-text',
        tooltip: 'script.sys-fnc-ackAlarms-tooltip',
        params: [false, false],
        paramsText: 'script.sys-fnc-ackAlarms-params'
    }
];
}

export class TemplatesCode {
    functions: SystemFunction[] = [];

    constructor(mode?: ScriptMode) {
        this.functions = this.allFunctions.filter(sf => !sf.mode || !mode || sf.mode === mode);
    }
    allFunctions = <SystemFunction[]>[{
        name: 'chart-data', mode: null, text: 'script.template-chart-data-text', tooltip: 'script.template-chart-data-tooltip',
        code: `// Add script parameter 'paramLines' as Chart lines (array)
if (paramLines && Array.isArray(paramLines)) {
    const count = 10;
    paramLines.forEach(line => {
        var y = [];
        var x = [];
        for (var i = 0; i < count; i++) {
            const randomNumber = Math.floor(Math.random() * 21);
            y.push(randomNumber);
            x.push(i);
        }
        line['y'] = y;
        line['x'] = x;
    });
    return paramLines;
} else {
    return 'Missing chart lines';
}`
    },
    {
        name: 'chart-data-touch', mode: null, text: 'script.template-chart-data-touch-text', tooltip: 'script.template-chart-data-touch-tooltip',
        code: `// Add script parameters 'paramLines' as Chart lines (array), 'xVal' as X axis touch point, 'yVal' as Y axis touch point
if (paramLines && Array.isArray(paramLines)) {
    const count = 10;
    paramLines.forEach(line => {
        var y = [];
        var x = [];
        for (var i = 0; i < count; i++) {
            const randomNumber = Math.floor(Math.random() * 21);
            y.push(randomNumber);
            x.push(i);
        }
      	if (typeof xVal === 'number' && typeof yVal === 'number') {
       		x.push(Math.round(xVal));
       		y.push(Math.round(yVal));
      	}
        line['y'] = y;
        line['x'] = x;
    });
    return paramLines;
} else {
    return 'Missing chart lines';
}`
    },
    {
        name: 'invoke-chart-update-options', mode: ScriptMode.CLIENT, text: 'script.template-invoke-chart-update-options-text', tooltip: 'script.template-invoke-chart-update-options-tooltip',
        code: `let opt = $invokeObject('chart_1', 'getOptions');
if (opt) {
    opt.scaleY1min = 100;
    opt.scaleY1max = 200;
}
$invokeObject('chart_1', 'updateOptions', opt);`
    },
    {
        name: 'getHistoricalTags', mode: null, text: 'script.template-getHistoricalTagsoptions-text', tooltip: 'script.template-getHistoricalTagsoptions-tooltip',
        code: `const to = Date.now();
var from = Date.now() - (1000 * 3600);  // 1 hour
var data = await $getHistoricalTags(['t_a95d5816-9f1e4a67' /* opcua - Byte */], from, to);
console.log(JSON.stringify(data));`
    }];
}

export interface SystemFunction {
    name: string;           // javascript function defined in backend
    text: string;           // button text
    tooltip: string;        // description
    params?: [boolean | string];     // array of function parameter where true is for tag and false for any (value)
    paramsText?: string;    // to add as parameter description in function
    code?: string;          // Code to paste
    mode?: ScriptMode;
    paramFilter?: ScriptParamFilterType;
}

export enum ScriptMode {
    CLIENT = 'CLIENT',
    SERVER = 'SERVER',
}

export enum ScriptParamFilterType {
    history = 'history'
}