blob: fbd31d0844e7b99bd213b1a4cd6e9332d091e664 [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 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
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// PhysicalPathTerminationPointVideoUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point video UNI
30const PhysicalPathTerminationPointVideoUniClassID ClassID = ClassID(82)
31
32var physicalpathterminationpointvideouniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointVideoUni (class ID #82)
35// This ME represents an RF video UNI in the ONU, where physical paths terminate and physical path
36// level functions are performed.
37//
38// The ONU automatically creates an instance of this ME per port:
39//
40// o when the ONU has RF video UNI ports built into its factory configuration;
41//
42// o when a cardholder is provisioned to expect a circuit pack of the video UNI type;
43//
44// o when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the video
45// UNI type. Note that the installation of a plug-and-play card may indicate the presence of video
46// ports via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-
47// mapping package that specifies video ports.
48//
49// The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
50// expect a video circuit pack, nor is it equipped with a video circuit pack.
51//
52// Relationships
53// One or more instances of this ME are associated with an instance of a real or virtual circuit
54// pack classified as video type.
55//
56// Attributes
57// Managed Entity Id
58// Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
59// number indicates the physical position of the UNI. The first byte is the slot ID (defined in
60// clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)
61//
62// Administrative State
63// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
64// ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)
65//
66// Operational State
67// Operational state: This attribute indicates whether the ME is capable of performing its
68// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
69//
70// Arc
71// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
72//
73// Arc Interval
74// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
75//
76// Power Control
77// Power control: This attribute controls whether power is provided from the ONU to an external
78// equipment over the video PPTP. Value 1 enables power over coaxial cable. The default value 0
79// disables power feed. (R,-W) (optional) (1-byte)
80//
81type PhysicalPathTerminationPointVideoUni struct {
82 ManagedEntityDefinition
83 Attributes AttributeValueMap
84}
85
86func init() {
87 physicalpathterminationpointvideouniBME = &ManagedEntityDefinition{
88 Name: "PhysicalPathTerminationPointVideoUni",
89 ClassID: 82,
90 MessageTypes: mapset.NewSetWith(
91 Get,
92 Set,
93 ),
94 AllowedAttributeMask: 0xf800,
95 AttributeDefinitions: AttributeDefinitionMap{
96 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
97 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
98 2: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, true, false, 2),
99 3: ByteField("Arc", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, true, false, 3),
100 4: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
101 5: ByteField("PowerControl", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, true, false, 5),
102 },
103 Access: CreatedByOnu,
104 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600105 Alarms: AlarmMap{
106 0: "Video-LOS",
107 1: "Video-OOR-low",
108 2: "Video-OOR-high",
109 },
Chip Boling6e27b352020-02-14 09:10:01 -0600110 }
111}
112
113// NewPhysicalPathTerminationPointVideoUni (class ID 82) creates the basic
114// Managed Entity definition that is used to validate an ME of this type that
115// is received from or transmitted to the OMCC.
116func NewPhysicalPathTerminationPointVideoUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
117 return NewManagedEntity(*physicalpathterminationpointvideouniBME, params...)
118}