blob: bc12ee8a301f6f43c18d9f41b8c0bb02604d6489 [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
4
Chip Boling6e27b352020-02-14 09:10:01 -06005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
Chip Boling6e27b352020-02-14 09:10:01 -060011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
David K. Bainbridgeadf422d2021-04-09 16:06:41 +000017/*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * NOTE: This file was generated, manual edits will be overwritten!
19 *
20 * Generated by 'goCodeGenerator.py':
21 * https://github.com/cboling/OMCI-parser/README.md
22 */
23
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// PhysicalPathTerminationPointPotsUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point POTS UNI
30const PhysicalPathTerminationPointPotsUniClassID ClassID = ClassID(53)
31
32var physicalpathterminationpointpotsuniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointPotsUni (class ID #53)
35// This ME represents a POTS UNI in the ONU, where a physical path terminates and physical path
36// level functions (analogue telephony) are performed.
37//
38// The ONU automatically creates an instance of this ME per port as follows.
39//
40// o When the ONU has POTS ports built into its factory configuration.
41//
42// o When a cardholder is provisioned to expect a circuit pack of the POTS type.
43//
44// o When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the POTS
45// type. Note that the installation of a plug-and-play card may indicate the presence of POTS ports
46// via equipment ID as well as type, and indeed may cause the ONU to instantiate a port-mapping
47// package that specifies POTS ports.
48//
49// The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
50// expect a POTS circuit pack, nor is it equipped with a POTS circuit pack.
51//
52// Relationships
53// An instance of this ME is associated with each real or pre-provisioned POTS port. Either a SIP
54// or a VoIP voice CTP links to the POTS UNI. Status is available from a VoIP line status ME, and
55// RTP and call control PM may be collected on this point.
56//
57// Attributes
58// Managed Entity Id
59// Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
60// number indicates the physical position of the UNI. The first byte is the slot ID (defined in
61// clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)
62//
63// Administrative State
64// When the administrative state is set to lock, all user functions of this UNI are blocked, and
65// alarms, TCAs and AVCs for this ME and all dependent MEs are no longer generated. Selection of a
66// default value for this attribute is outside the scope of this Recommendation. (R, W) (mandatory)
67// (1 byte)
68//
69// Deprecated
70// Deprecated: This attribute is not used and should not be supported. (R,-W) (optional) (2-bytes)
71//
72// Arc
73// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
74//
75// Arc Interval
76// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
77//
78// Impedance
79// where C1, R1, and R2 are related as shown in Figure 9.9.1-1. Upon ME instantiation, the ONU sets
80// this attribute to 0. (R,-W) (optional) (1-byte)
81//
82// Transmission Path
83// Transmission path: This attribute allows setting the POTS UNI either to full-time on-hook
84// transmission (0) or part-time on-hook transmission (1). Upon ME instantiation, the ONU sets this
85// attribute to 0. (R,-W) (optional) (1-byte)
86//
87// Rx Gain
88// Rx gain: This attribute specifies a gain value for the received signal in the form of a 2s
89// complement number. Valid values are -120 (12.0-dB) to 60 (+6.0-dB). The direction of the
90// affected signal is in the D to A direction, towards the telephone set. Upon ME instantiation,
91// the ONU sets this attribute to 0. (R, W) (optional) (1 byte)
92//
93// Tx Gain
94// Tx gain: This attribute specifies a gain value for the transmit signal in the form of a 2s
95// complement number. Valid values are -120 (12.0-dB) to 60 (+6.0-dB). The direction of the
96// affected signal is in the A to D direction, away from the telephone set. Upon ME instantiation,
97// the ONU sets this attribute to 0. (R, W) (optional) (1 byte)
98//
99// Operational State
100// Operational state: This attribute indicates whether the ME is capable of performing its
101// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
102//
103// Hook State
104// Hook state: This attribute indicates the current state of the subscriber line: 0-= on hook, 1-=
105// off hook (R) (optional) (1-byte)
106//
107// Pots Holdover Time
108// POTS holdover time: This attribute determines the time during which the POTS loop voltage is
109// held up when a LOS or softswitch connectivity is detected (please refer to the following table
110// for description of behaviours).. After the specified time elapses, the ONU drops the loop
111// voltage, and may thereby cause premises intrusion alarm or fire panel circuits to go active.
112// When the ONU ranges successfully on the PON or softswitch connectivity is restored, it restores
113// the POTS loop voltage immediately and resets the timer to zero. The attribute is expressed in
114// seconds. The default value 0 selects the vendor's factory policy. (R,-W) (optional) (2-bytes)
115//
116// Nominal Feed Voltage
117// Nominal feed voltage: This attribute indicates the designed nominal feed voltage of the POTS
118// loop. It is an absolute value with resolution 1-V. This attribute does not represent the actual
119// voltage measured on the loop, which is available through the test command. (R,-W) (optional)
120// (1-byte)
121//
122// Loss Of Softswitch
123// Loss of softswitch: This Boolean attribute controls whether the T/R holdover initiation
124// criteria. False disables loss of softswitch connectivity detection as criteria for initiating
125// the POTS holdover timer. True enables loss of softswitch connectivity detection as criteria for
126// initiating the POTS holdover timer. This attribute is optional (if not implemented, the POTS
127// holdover time is triggered on a LOS when POTS holdover is greater than zero). (R,-W) (optional)
128// (1-byte)
129//
130type PhysicalPathTerminationPointPotsUni struct {
131 ManagedEntityDefinition
132 Attributes AttributeValueMap
133}
134
135func init() {
136 physicalpathterminationpointpotsuniBME = &ManagedEntityDefinition{
137 Name: "PhysicalPathTerminationPointPotsUni",
138 ClassID: 53,
139 MessageTypes: mapset.NewSetWith(
140 Get,
141 Set,
142 Test,
143 ),
144 AllowedAttributeMask: 0xfff8,
145 AttributeDefinitions: AttributeDefinitionMap{
146 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
147 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), true, false, false, 1),
148 2: Uint16Field("Deprecated", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, true, true, 2),
149 3: ByteField("Arc", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, true, false, 3),
150 4: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
151 5: ByteField("Impedance", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, true, false, 5),
152 6: ByteField("TransmissionPath", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, true, false, 6),
153 7: ByteField("RxGain", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, true, false, 7),
154 8: ByteField("TxGain", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, true, false, 8),
155 9: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), true, true, false, 9),
156 10: ByteField("HookState", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, true, false, 10),
157 11: Uint16Field("PotsHoldoverTime", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
158 12: ByteField("NominalFeedVoltage", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12),
159 13: ByteField("LossOfSoftswitch", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13),
160 },
161 Access: CreatedByOnu,
162 Support: UnknownSupport,
163 }
164}
165
166// NewPhysicalPathTerminationPointPotsUni (class ID 53) creates the basic
167// Managed Entity definition that is used to validate an ME of this type that
168// is received from or transmitted to the OMCC.
169func NewPhysicalPathTerminationPointPotsUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
170 return NewManagedEntity(*physicalpathterminationpointpotsuniBME, params...)
171}