NAVFoundation.Amx/ModuleBase/NAVFoundation.ModuleBase.axi at master · Norgate-AV/NAVFoundation.Amx · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
PROGRAM_NAME='NAVFoundation.ModuleBase'

/*
 _   _                       _          ___     __
| \ | | ___  _ __ __ _  __ _| |_ ___   / \ \   / /
|  \| |/ _ \| '__/ _` |/ _` | __/ _ \ / _ \ \ / /
| |\  | (_) | | | (_| | (_| | ||  __// ___ \ V /
|_| \_|\___/|_|  \__, |\__,_|\__\___/_/   \_\_/
                 |___/

MIT License

Copyright (c) 2010-2026 Norgate AV

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#IF_NOT_DEFINED __NAV_FOUNDATION_MODULEBASE__
#DEFINE __NAV_FOUNDATION_MODULEBASE__ 'NAVFoundation.ModuleBase'

#include 'NAVFoundation.Core.h.axi'
#include 'NAVFoundation.ArrayUtils.axi'
#include 'NAVFoundation.SnapiHelpers.axi'
#include 'NAVFoundation.ModuleBase.h.axi'

DEFINE_CONSTANT

// Required to handle events on 'vdvObject'
// #DEFINE USING_NAV_MODULE_BASE_CALLBACKS

// #DEFINE USING_NAV_MODULE_BASE_PROPERTY_EVENT_CALLBACK
// define_function NAVModulePropertyEventCallback(_NAVModulePropertyEvent event) {}

// #DEFINE USING_NAV_MODULE_BASE_PASSTHRU_EVENT_CALLBACK
// define_function NAVModulePassthruEventCallback(_NAVModulePassthruEvent event) {}

// !!! You must define the module variable in your main .axs file !!!

// DEFINE_VARIABLE

// _NAVModule module


define_function NAVModulePropertyEventInit(dev device, _NAVSnapiMessage message, _NAVModulePropertyEvent event) {
    event.Device = device
    event.FullMessage = message
    event.Name = message.Parameter[1]

    if (length_array(message.Parameter) < 2) {
        return
    }

    NAVArraySliceString(message.Parameter, 2, length_array(message.Parameter), event.Args)
}


define_function NAVModulePassthruEventInit(dev device, _NAVSnapiMessage message, _NAVModulePassthruEvent event) {
    event.Device = device
    event.FullMessage = message
    event.Payload = message.Parameter[1]
}


define_function NAVModuleInit(_NAVModule module) {
    module.RxBuffer.Semaphore = false

    module.Device.IsOnline = false
    module.Device.IsCommunicating = false
    module.Device.IsInitialized = false

    module.Device.SocketConnection.IsConnected = false
    module.Device.SocketConnection.IsAuthenticated = false
    module.Device.SocketConnection.Interval[1] = 0
    set_length_array(module.Device.SocketConnection.Interval, 1)
    module.Device.SocketConnection.RetryCount = 0

    module.Enabled = true
    module.CommandBusy = false
}


DEFINE_EVENT

#IF_DEFINED USING_NAV_MODULE_BASE_CALLBACKS
data_event[vdvObject] {
    command: {
        stack_var _NAVSnapiMessage message

        NAVParseSnapiMessage(data.text, message)

        switch (message.Header) {
            case NAV_MODULE_PROPERTY_EVENT: {
                #IF_DEFINED USING_NAV_MODULE_BASE_PROPERTY_EVENT_CALLBACK
                stack_var _NAVModulePropertyEvent event

                NAVModulePropertyEventInit(data.device, message, event)

                NAVModulePropertyEventCallback(event)
                #END_IF
            }
            case NAV_MODULE_PASSTHRU_EVENT: {
                #IF_DEFINED USING_NAV_MODULE_BASE_PASSTHRU_EVENT_CALLBACK
                stack_var _NAVModulePassthruEvent event

                NAVModulePassthruEventInit(data.device, message, event)

                NAVModulePassthruEventCallback(event)
                #END_IF
            }
        }
    }
}
#END_IF // USING_NAV_MODULE_BASE_CALLBACKS


#END_IF // __NAV_FOUNDATION_MODULEBASE__