libamxb  4.8.2
Bus Agnostic C API
test.odl
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 #!/usr/bin/amxrt
55 
57  // Application name
58  name = "test_dm";
59 
60  uris = ["pcb:/tmp/test.sock"];
61  backends = ["/usr/bin/mods/amxb/mod-amxb-pcb.so"];
62 
63  // amxrt config-options
64  auto-detect = false;
65  auto-connect = true;
66  daemon = false;
67  priority = 0;
68 }
69 
70 %define {
71  object Device {
72  object Ethernet {
73  bool WolSupport = false;
74 
75  object Interface[] {
76  counted with InterfaceNumberOfEntries;
77  bool Enable = true;
78  string Status {
79  default "Down";
80  on action validate call check_enum ["Up", "Down", "Unknown", "Dormant", "NotPresent", "LowerLayerDown", "Error"];
81  }
82 
83  object Stats {
84  uint32 BytesSent;
85  uint32 BytesReceived;
86  }
87  }
88  }
89  }
90 }
91 
92 %define {
93  object MQTT {
94  object Capabilities {
95  %read-only csv_string ProtocolVersionsSupported = "3.1,3.1.1,5.0";
96  %read-only csv_string TransportProtocolSupported = "TCP/IP,TLS,WebSocket";
97  }
98 
99  object Client[] {
100  counted with ClientNumberOfEntries;
101 
102  %unique %key string Alias;
103  string Name;
104  bool Enable = false;
105  %read-only string Status = "Disabled" {
106  on action validate call check_enum
107  ["Disabled", "Connecting", "Connected",
108  "Error_Misconfigured", "Error_BrokerUnreachable",
109  "Error"];
110  }
111  string BrokerAddress;
112  uint32 BrokerPort = 1883;
113  string TransportProtocol = "TCP/IP";
114  bool CleanSession = true;
115  bool CleanStart = true;
116  uint32 KeepAliveTime = 60;
117  string ClientId = "";
118  }
119  }
120 }
121 
122 %populate {
123  object Device.Ethernet.Interface {
124  instance add (0,"") {
125  parameter Status = "Up";
126  }
127  instance add (0,"") {
128  parameter Status = "Down";
129  }
130  instance add (0,"") {
131  parameter Enable = false;
132  parameter Status = "NotPresent";
133  }
134  instance add (0,"") {
135  parameter Enable = false;
136  parameter Status = "Error";
137  }
138  instance add (0,"") {
139  parameter Status = "Dormant";
140  }
141  }
142 }
143 
144 %populate {
145  object MQTT.Client {
146  instance add(0, "cpe-mybroker") {
147  parameter Name = "MyBroker";
148  parameter BrokerAddress = "www.mybroker.com";
149  parameter ClientId = "test";
150  }
151  instance add(0, "cpe-hivemq") {
152  parameter Name = "HiveMQ";
153  parameter BrokerAddress = "www.hivemq.com";
154  parameter ClientId = "test-hivemq";
155  }
156  }
157 }
uris
Definition: test.odl:60
daemon
Definition: test.odl:66
priority
Definition: test.odl:67
backends
Definition: test.odl:61
auto connect
Definition: test.odl:65
config
Definition: test.odl:56
auto detect
Definition: test.odl:64