1 module o-ran-externalio {
3 namespace "urn:o-ran:external-io:1.0";
6 organization "O-RAN Alliance";
12 "This module defines the input state and output configuration for
15 Copyright 2019 the O-RAN Alliance.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 POSSIBILITY OF SUCH DAMAGE.
29 Redistribution and use in source and binary forms, with or without
30 modification, are permitted provided that the following conditions are met:
32 * Redistributions of source code must retain the above copyright notice,
33 this list of conditions and the above disclaimer.
34 * Redistributions in binary form must reproduce the above copyright notice,
35 this list of conditions and the above disclaimer in the documentation
36 and/or other materials provided with the distribution.
37 * Neither the Members of the O-RAN Alliance nor the names of its
38 contributors may be used to endorse or promote products derived from
39 this software without specific prior written permission.";
41 revision "2019-07-03" {
45 1) backward compatible changes to introduce groupings.";
47 reference "ORAN-WG4.M.0-v01.00";
50 revision "2019-02-04" {
54 1) imported model from xRAN
55 2) changed namespace and reference from xran to o-ran";
57 reference "ORAN-WG4.M.0-v01.00";
60 grouping external-io-group {
61 description "an external io grouping";
66 "Leaf nodes describing external line inputs";
72 "A unique name that identifies an input port instance.
73 This name may be used in fault management to refer to a fault source
79 "A number which identifies an external input port.";
86 "Value TRUE indicates that circuit is open.
87 Value FALSE indicates that circuit is closed.
89 Usually when nothing is connected to the line the value is TRUE.
90 The details of external line-in implementation are HW specific.";
98 "Leaf nodes describing external line outputs";
104 "A name that is unique that identifies an output port instance.
105 This name may be used in fault management to refer to a fault source
112 "A number which identifies an external output port.";
116 list output-setting {
120 "List allowing to set output line state";
124 path "/external-io/output/name";
125 require-instance false;
130 "Name derived from unmodifiable list external-io";
137 "Value TRUE indicates that circuit is in its natural state.
138 Value FALSE indicates that circuit is not in its natural state.";
143 grouping notification-group {
144 description "a notification grouping";
145 container current-input-notification {
146 description "a container for the state of the input ports";
147 list external-input {
149 description "a list of the input ports and their state";
152 path "/external-io/input/name";
154 description "the name of the ald-port";
158 path "/external-io/input/port-in";
160 description "the external input port";
164 path "/external-io/input/line-in";
166 description "the state of the external input port";
172 // Top Level Container
174 container external-io {
176 "External IO information.";
177 uses external-io-group;
180 notification external-input-change {
182 "Notification used to indicate that external line input has changed state";
183 uses notification-group;