aes70 1.6.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COPYING +7 -7
- package/Changelog +9 -0
- package/README.md +74 -42
- package/dist/AES70.es5.js +24520 -1
- package/package.json +3 -3
- package/src/OCP1/Arguments.js +3 -0
- package/src/OCP1/Enum.js +8 -0
- package/src/OCP1/OcaActionObjectSearchResult.js +20 -0
- package/src/OCP1/OcaActionObjectSearchResultFlags.js +3 -0
- package/src/OCP1/OcaArray1D.js +108 -0
- package/src/OCP1/OcaBitstring.js +3 -0
- package/src/OCP1/OcaBlob.js +2 -43
- package/src/OCP1/OcaBlobFixedLen.js +8 -0
- package/src/OCP1/OcaBlockConfigurability.js +3 -0
- package/src/OCP1/OcaBoolean.js +3 -0
- package/src/OCP1/OcaCommand.js +17 -0
- package/src/OCP1/OcaCommandResult.js +17 -0
- package/src/OCP1/OcaCommandSetResult.js +17 -0
- package/src/OCP1/OcaConstructionParameter.js +16 -0
- package/src/OCP1/OcaCounter.js +22 -0
- package/src/OCP1/OcaCounterNotifierFilterParameters.js +19 -0
- package/src/OCP1/OcaCounterSet.js +17 -0
- package/src/OCP1/OcaCounterUpdate.js +18 -0
- package/src/OCP1/OcaCounterUpdateEventData.js +15 -0
- package/src/OCP1/OcaDatasetSearchResult.js +17 -0
- package/src/OCP1/OcaDeviceGenericState.js +4 -0
- package/src/OCP1/OcaDeviceOperationalState.js +16 -0
- package/src/OCP1/OcaExecutableType.js +4 -0
- package/src/OCP1/OcaFloat32.js +3 -0
- package/src/OCP1/OcaFloat64.js +3 -0
- package/src/OCP1/OcaGenericEndState.js +4 -0
- package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
- package/src/OCP1/OcaGroupException.js +18 -0
- package/src/OCP1/OcaIODirection.js +4 -0
- package/src/OCP1/OcaIP4AutoconfigMode.js +4 -0
- package/src/OCP1/OcaIP4Gateway.js +17 -0
- package/src/OCP1/OcaIP4NetworkSettings.js +23 -0
- package/src/OCP1/OcaIP6AutoconfigMode.js +4 -0
- package/src/OCP1/OcaIP6Gateway.js +17 -0
- package/src/OCP1/OcaIP6NetworkSettings.js +24 -0
- package/src/OCP1/OcaInt16.js +3 -0
- package/src/OCP1/OcaInt32.js +3 -0
- package/src/OCP1/OcaInt64.js +3 -0
- package/src/OCP1/OcaInt8.js +3 -0
- package/src/OCP1/OcaInterval.js +18 -0
- package/src/OCP1/OcaIntervalBounds.js +3 -0
- package/src/OCP1/OcaJobDisposedEventData.js +18 -0
- package/src/OCP1/OcaJobDisposition.js +4 -0
- package/src/OCP1/OcaJobQueueItem.js +24 -0
- package/src/OCP1/OcaList.js +2 -127
- package/src/OCP1/OcaList2D.js +6 -0
- package/src/OCP1/OcaList32.js +3 -0
- package/src/OCP1/OcaLockState.js +4 -0
- package/src/OCP1/OcaLogFilter.js +20 -0
- package/src/OCP1/OcaLogRecord.js +21 -0
- package/src/OCP1/OcaLongBlob.js +3 -0
- package/src/OCP1/OcaManufacturer.js +19 -0
- package/src/OCP1/OcaMap.js +3 -0
- package/src/OCP1/OcaMatrixCommand.js +19 -0
- package/src/OCP1/OcaMatrixCoordinates.js +15 -0
- package/src/OCP1/OcaMediaAccessMode.js +4 -0
- package/src/OCP1/OcaMediaFrameFormat.js +4 -0
- package/src/OCP1/OcaMediaPlayOption.js +4 -0
- package/src/OCP1/OcaMediaRecorderPlayerState.js +4 -0
- package/src/OCP1/OcaMediaStreamEndpoint.js +40 -0
- package/src/OCP1/OcaMediaStreamEndpointCommand.js +4 -0
- package/src/OCP1/OcaMediaStreamEndpointState.js +4 -0
- package/src/OCP1/OcaMediaStreamEndpointStatus.js +16 -0
- package/src/OCP1/OcaMediaStreamMode.js +21 -0
- package/src/OCP1/OcaMediaStreamModeCapability.js +29 -0
- package/src/OCP1/OcaMediaStreamModeCapabilityDirection.js +3 -0
- package/src/OCP1/OcaMediaTrackFunction.js +3 -0
- package/src/OCP1/OcaMediaTransportSession.js +30 -0
- package/src/OCP1/OcaMediaTransportSessionConnection.js +17 -0
- package/src/OCP1/OcaMediaTransportSessionConnectionState.js +15 -0
- package/src/OCP1/OcaMediaTransportSessionState.js +4 -0
- package/src/OCP1/OcaMediaTransportSessionStatus.js +16 -0
- package/src/OCP1/OcaMediaTransportTimingParameters.js +16 -0
- package/src/OCP1/OcaMediaVolumePosition.js +16 -0
- package/src/OCP1/OcaMediaVolumePositionType.js +4 -0
- package/src/OCP1/OcaMultiMap.js +3 -0
- package/src/OCP1/OcaNetworkAdvertisingMechanism.js +16 -0
- package/src/OCP1/OcaNetworkAdvertisingService.js +4 -0
- package/src/OCP1/OcaNetworkInterfaceAssignment.js +23 -0
- package/src/OCP1/OcaNetworkInterfaceCommand.js +4 -0
- package/src/OCP1/OcaNetworkInterfaceState.js +4 -0
- package/src/OCP1/OcaNetworkInterfaceStatus.js +16 -0
- package/src/OCP1/OcaObjectSearchResult.js +2 -18
- package/src/OCP1/OcaObjectSearchResultFlags.js +5 -3
- package/src/OCP1/OcaPort.js +1 -1
- package/src/OCP1/OcaPortClockMapEntry.js +16 -0
- package/src/OCP1/OcaPortID.js +2 -2
- package/src/OCP1/OcaPortIdentification.js +16 -0
- package/src/OCP1/OcaPortMode.js +5 -4
- package/src/OCP1/OcaPositionDescriptor.js +2 -2
- package/src/OCP1/OcaProduct.js +19 -0
- package/src/OCP1/OcaProgramResult.js +17 -0
- package/src/OCP1/OcaProgramRunMode.js +3 -0
- package/src/OCP1/OcaProtoPort.js +2 -2
- package/src/OCP1/OcaProtoPortClockMapEntry.js +17 -0
- package/src/OCP1/OcaProtoSignalPath.js +2 -2
- package/src/OCP1/OcaSamplingRateConverterType.js +4 -0
- package/src/OCP1/OcaSecurityType.js +4 -0
- package/src/OCP1/OcaSignalPath.js +2 -2
- package/src/OCP1/OcaString.js +3 -0
- package/src/OCP1/OcaTask.js +4 -3
- package/src/OCP1/OcaTaskExecutionTerminatedEventData.js +20 -0
- package/src/OCP1/OcaTaskGenericState.js +4 -0
- package/src/OCP1/OcaTaskOperationalState.js +17 -0
- package/src/OCP1/OcaTaskSchedulerState.js +4 -0
- package/src/OCP1/OcaTaskStatusChangedEventData.js +18 -0
- package/src/OCP1/OcaTime.js +18 -0
- package/src/OCP1/OcaTimeDeliveryMechanism.js +4 -0
- package/src/OCP1/OcaTimeDeliveryParameters_StreamEndpoint.js +15 -0
- package/src/OCP1/OcaTimePTP.js +2 -15
- package/src/OCP1/OcaTypedBlob.js +16 -0
- package/src/OCP1/OcaUint16.js +3 -0
- package/src/OCP1/OcaUint32.js +3 -0
- package/src/OCP1/OcaUint64.js +3 -0
- package/src/OCP1/OcaUint8.js +3 -0
- package/src/OCP1/OcaVariant.js +92 -0
- package/src/OCP1/OcaWhenPhysicalAbsolute.js +16 -0
- package/src/OCP1/OcaWhenPhysicalRelative.js +16 -0
- package/src/OCP1/RestWithOffset.js +3 -0
- package/src/OCP1/String16.js +3 -0
- package/src/OCP1/Struct.js +12 -0
- package/src/OCP1/Tuple.js +3 -0
- package/src/OCP1/createBlobType.js +58 -0
- package/src/OCP1/createListType.js +137 -0
- package/src/OCP1/createType.js +8 -4
- package/src/OCP1/decode_message.js +10 -2
- package/src/OCP1/encode_message.js +5 -1
- package/src/OCP1/getLengthEncoder.js +23 -0
- package/src/OCP1/notification2.js +70 -0
- package/src/OCP1/protocol_version.js +4 -0
- package/src/connection.js +14 -6
- package/src/controller/ControlClasses/OcaActuator.d.ts +3 -3
- package/src/controller/ControlClasses/OcaActuator.js +4 -4
- package/src/controller/ControlClasses/OcaAgent.d.ts +6 -14
- package/src/controller/ControlClasses/OcaAgent.js +8 -18
- package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +9 -17
- package/src/controller/ControlClasses/OcaApplicationNetwork.js +11 -32
- package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +4 -7
- package/src/controller/ControlClasses/OcaAudioLevelSensor.js +5 -8
- package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +1 -1
- package/src/controller/ControlClasses/OcaAudioProcessingManager.js +2 -2
- package/src/controller/ControlClasses/OcaBasicActuator.d.ts +1 -1
- package/src/controller/ControlClasses/OcaBasicActuator.js +2 -2
- package/src/controller/ControlClasses/OcaBasicSensor.d.ts +1 -1
- package/src/controller/ControlClasses/OcaBasicSensor.js +2 -2
- package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +34 -13
- package/src/controller/ControlClasses/OcaBitstringActuator.js +35 -18
- package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +19 -7
- package/src/controller/ControlClasses/OcaBitstringSensor.js +22 -12
- package/src/controller/ControlClasses/OcaBlock.d.ts +455 -89
- package/src/controller/ControlClasses/OcaBlock.js +477 -103
- package/src/controller/ControlClasses/OcaBlockFactoryAgent.d.ts +299 -0
- package/src/controller/ControlClasses/OcaBlockFactoryAgent.js +360 -0
- package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +2 -4
- package/src/controller/ControlClasses/OcaBooleanActuator.js +3 -5
- package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaBooleanSensor.js +3 -4
- package/src/controller/ControlClasses/OcaCodingManager.js +1 -1
- package/src/controller/ControlClasses/OcaCommandSet.d.ts +89 -0
- package/src/controller/ControlClasses/OcaCommandSet.js +94 -0
- package/src/controller/ControlClasses/OcaCommandSetAgent.d.ts +31 -0
- package/src/controller/ControlClasses/OcaCommandSetAgent.js +38 -0
- package/src/controller/ControlClasses/OcaCounterNotifier.d.ts +89 -0
- package/src/controller/ControlClasses/OcaCounterNotifier.js +101 -0
- package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaCurrentSensor.js +3 -4
- package/src/controller/ControlClasses/OcaDataset.d.ts +223 -0
- package/src/controller/ControlClasses/OcaDataset.js +234 -0
- package/src/controller/ControlClasses/OcaDatasetWorker.d.ts +31 -0
- package/src/controller/ControlClasses/OcaDatasetWorker.js +40 -0
- package/src/controller/ControlClasses/OcaDelay.d.ts +2 -4
- package/src/controller/ControlClasses/OcaDelay.js +3 -5
- package/src/controller/ControlClasses/OcaDelayExtended.d.ts +5 -7
- package/src/controller/ControlClasses/OcaDelayExtended.js +6 -8
- package/src/controller/ControlClasses/OcaDeviceManager.d.ts +123 -62
- package/src/controller/ControlClasses/OcaDeviceManager.js +161 -83
- package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +43 -25
- package/src/controller/ControlClasses/OcaDeviceTimeManager.js +43 -28
- package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +1 -13
- package/src/controller/ControlClasses/OcaDiagnosticManager.js +3 -16
- package/src/controller/ControlClasses/OcaDynamics.d.ts +38 -63
- package/src/controller/ControlClasses/OcaDynamics.js +48 -71
- package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +169 -82
- package/src/controller/ControlClasses/OcaDynamicsCurve.js +189 -93
- package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +8 -16
- package/src/controller/ControlClasses/OcaDynamicsDetector.js +9 -17
- package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +5 -7
- package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +10 -12
- package/src/controller/ControlClasses/OcaFilterClassical.d.ts +15 -26
- package/src/controller/ControlClasses/OcaFilterClassical.js +15 -27
- package/src/controller/ControlClasses/OcaFilterFIR.d.ts +6 -11
- package/src/controller/ControlClasses/OcaFilterFIR.js +12 -18
- package/src/controller/ControlClasses/OcaFilterParametric.d.ts +55 -26
- package/src/controller/ControlClasses/OcaFilterParametric.js +63 -32
- package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +5 -4
- package/src/controller/ControlClasses/OcaFilterPolynomial.js +8 -7
- package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +6 -11
- package/src/controller/ControlClasses/OcaFirmwareManager.js +5 -11
- package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaFloat32Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaFloat32Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaFloat64Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaFloat64Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +2 -4
- package/src/controller/ControlClasses/OcaFrequencyActuator.js +3 -5
- package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +1 -2
- package/src/controller/ControlClasses/OcaFrequencySensor.js +2 -3
- package/src/controller/ControlClasses/OcaGain.d.ts +2 -4
- package/src/controller/ControlClasses/OcaGain.js +3 -5
- package/src/controller/ControlClasses/OcaGainSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaGainSensor.js +3 -4
- package/src/controller/ControlClasses/OcaGroup.d.ts +140 -0
- package/src/controller/ControlClasses/OcaGroup.js +156 -0
- package/src/controller/ControlClasses/OcaGrouper.d.ts +20 -140
- package/src/controller/ControlClasses/OcaGrouper.js +34 -171
- package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +5 -7
- package/src/controller/ControlClasses/OcaIdentificationActuator.js +7 -9
- package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +5 -6
- package/src/controller/ControlClasses/OcaIdentificationSensor.js +6 -7
- package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaImpedanceSensor.js +3 -4
- package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaInt16Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaInt16Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaInt32Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaInt32Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaInt64Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaInt64Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaInt8Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaInt8Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaJsonActuator.d.ts +46 -0
- package/src/controller/ControlClasses/OcaJsonActuator.js +58 -0
- package/src/controller/ControlClasses/OcaJsonSensor.d.ts +51 -0
- package/src/controller/ControlClasses/OcaJsonSensor.js +65 -0
- package/src/controller/ControlClasses/OcaLevelSensor.d.ts +1 -2
- package/src/controller/ControlClasses/OcaLevelSensor.js +2 -3
- package/src/controller/ControlClasses/OcaLibraryManager.d.ts +1 -1
- package/src/controller/ControlClasses/OcaLibraryManager.js +3 -3
- package/src/controller/ControlClasses/OcaLockManager.d.ts +44 -0
- package/src/controller/ControlClasses/OcaLockManager.js +53 -0
- package/src/controller/ControlClasses/OcaLog.d.ts +128 -0
- package/src/controller/ControlClasses/OcaLog.js +142 -0
- package/src/controller/ControlClasses/OcaManager.js +1 -1
- package/src/controller/ControlClasses/OcaMatrix.d.ts +104 -82
- package/src/controller/ControlClasses/OcaMatrix.js +121 -93
- package/src/controller/ControlClasses/OcaMediaClock.d.ts +27 -0
- package/src/controller/ControlClasses/OcaMediaClock.js +28 -4
- package/src/controller/ControlClasses/OcaMediaClock3.d.ts +16 -22
- package/src/controller/ControlClasses/OcaMediaClock3.js +22 -29
- package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +7 -10
- package/src/controller/ControlClasses/OcaMediaClockManager.js +9 -13
- package/src/controller/ControlClasses/OcaMediaRecorderPlayer.d.ts +235 -0
- package/src/controller/ControlClasses/OcaMediaRecorderPlayer.js +261 -0
- package/src/controller/ControlClasses/OcaMediaTransportApplication.d.ts +612 -0
- package/src/controller/ControlClasses/OcaMediaTransportApplication.js +704 -0
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +12 -25
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +12 -35
- package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.d.ts +235 -0
- package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.js +249 -0
- package/src/controller/ControlClasses/OcaMute.d.ts +2 -4
- package/src/controller/ControlClasses/OcaMute.js +3 -5
- package/src/controller/ControlClasses/OcaNetwork.js +1 -1
- package/src/controller/ControlClasses/OcaNetworkApplication.d.ts +179 -0
- package/src/controller/ControlClasses/OcaNetworkApplication.js +202 -0
- package/src/controller/ControlClasses/OcaNetworkInterface.d.ts +318 -0
- package/src/controller/ControlClasses/OcaNetworkInterface.js +353 -0
- package/src/controller/ControlClasses/OcaNetworkManager.d.ts +45 -17
- package/src/controller/ControlClasses/OcaNetworkManager.js +59 -22
- package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +1 -1
- package/src/controller/ControlClasses/OcaNumericObserver.d.ts +24 -40
- package/src/controller/ControlClasses/OcaNumericObserver.js +25 -40
- package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +20 -33
- package/src/controller/ControlClasses/OcaNumericObserverList.js +26 -39
- package/src/controller/ControlClasses/OcaPanBalance.d.ts +4 -8
- package/src/controller/ControlClasses/OcaPanBalance.js +5 -9
- package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +3 -6
- package/src/controller/ControlClasses/OcaPhysicalPosition.js +4 -7
- package/src/controller/ControlClasses/OcaPolarity.d.ts +2 -4
- package/src/controller/ControlClasses/OcaPolarity.js +3 -5
- package/src/controller/ControlClasses/OcaPowerManager.d.ts +30 -14
- package/src/controller/ControlClasses/OcaPowerManager.js +32 -17
- package/src/controller/ControlClasses/OcaPowerSensor.d.ts +38 -0
- package/src/controller/ControlClasses/OcaPowerSensor.js +51 -0
- package/src/controller/ControlClasses/OcaPowerSupply.d.ts +8 -16
- package/src/controller/ControlClasses/OcaPowerSupply.js +13 -21
- package/src/controller/ControlClasses/OcaProgram.d.ts +63 -0
- package/src/controller/ControlClasses/OcaProgram.js +82 -0
- package/src/controller/ControlClasses/OcaRamper.d.ts +46 -10
- package/src/controller/ControlClasses/OcaRamper.js +65 -12
- package/src/controller/ControlClasses/OcaRoot.d.ts +69 -24
- package/src/controller/ControlClasses/OcaRoot.js +67 -26
- package/src/controller/ControlClasses/OcaSamplingRateConverter.d.ts +22 -0
- package/src/controller/ControlClasses/OcaSamplingRateConverter.js +28 -0
- package/src/controller/ControlClasses/OcaSecurityManager.d.ts +12 -13
- package/src/controller/ControlClasses/OcaSecurityManager.js +10 -12
- package/src/controller/ControlClasses/OcaSensor.d.ts +1 -2
- package/src/controller/ControlClasses/OcaSensor.js +2 -3
- package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +21 -39
- package/src/controller/ControlClasses/OcaSignalGenerator.js +22 -40
- package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -4
- package/src/controller/ControlClasses/OcaSignalInput.js +5 -5
- package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -4
- package/src/controller/ControlClasses/OcaSignalOutput.js +5 -5
- package/src/controller/ControlClasses/OcaStateSensor.d.ts +58 -0
- package/src/controller/ControlClasses/OcaStateSensor.js +75 -0
- package/src/controller/ControlClasses/OcaStreamConnector.js +1 -1
- package/src/controller/ControlClasses/OcaStreamNetwork.js +1 -1
- package/src/controller/ControlClasses/OcaStringActuator.d.ts +7 -8
- package/src/controller/ControlClasses/OcaStringActuator.js +7 -8
- package/src/controller/ControlClasses/OcaStringSensor.d.ts +20 -9
- package/src/controller/ControlClasses/OcaStringSensor.js +23 -13
- package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +211 -41
- package/src/controller/ControlClasses/OcaSubscriptionManager.js +224 -39
- package/src/controller/ControlClasses/OcaSummingPoint.d.ts +3 -2
- package/src/controller/ControlClasses/OcaSummingPoint.js +4 -3
- package/src/controller/ControlClasses/OcaSwitch.d.ts +70 -25
- package/src/controller/ControlClasses/OcaSwitch.js +113 -35
- package/src/controller/ControlClasses/OcaTaskAgent.d.ts +192 -0
- package/src/controller/ControlClasses/OcaTaskAgent.js +212 -0
- package/src/controller/ControlClasses/OcaTaskManager.d.ts +4 -6
- package/src/controller/ControlClasses/OcaTaskManager.js +7 -9
- package/src/controller/ControlClasses/OcaTaskScheduler.d.ts +150 -0
- package/src/controller/ControlClasses/OcaTaskScheduler.js +159 -0
- package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaTemperatureActuator.js +4 -6
- package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaTemperatureSensor.js +3 -4
- package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +1 -2
- package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +2 -3
- package/src/controller/ControlClasses/OcaTimeSource.d.ts +108 -37
- package/src/controller/ControlClasses/OcaTimeSource.js +148 -48
- package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaUint16Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaUint16Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaUint32Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaUint32Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaUint64Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaUint64Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +3 -5
- package/src/controller/ControlClasses/OcaUint8Actuator.js +4 -6
- package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaUint8Sensor.js +3 -4
- package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +2 -3
- package/src/controller/ControlClasses/OcaVoltageSensor.js +3 -4
- package/src/controller/ControlClasses/OcaWorker.d.ts +84 -37
- package/src/controller/ControlClasses/OcaWorker.js +93 -43
- package/src/controller/base_event.js +71 -23
- package/src/controller/client_connection.d.ts +26 -0
- package/src/controller/client_connection.js +39 -7
- package/src/controller/event.js +17 -20
- package/src/controller/make_control_class.js +3 -1
- package/src/controller/notification_error.d.ts +40 -0
- package/src/controller/notification_error.js +62 -0
- package/src/controller/observeProperty.js +8 -8
- package/src/controller/property_event.js +18 -10
- package/src/controller/remote_device.js +137 -49
- package/src/controller/tcp_connection.d.ts +8 -6
- package/src/index.default.d.ts +1 -0
- package/src/index.default.js +1 -0
- package/src/types/Enum.js +8 -0
- package/src/types/OcaActionObjectSearchResult.d.ts +73 -0
- package/src/types/OcaActionObjectSearchResult.js +34 -0
- package/src/types/OcaActionObjectSearchResultFlags.d.ts +37 -0
- package/src/types/OcaActionObjectSearchResultFlags.js +52 -0
- package/src/types/OcaApplicationNetworkCommand.d.ts +1 -19
- package/src/types/OcaApplicationNetworkCommand.js +0 -24
- package/src/types/OcaApplicationNetworkState.d.ts +1 -37
- package/src/types/OcaApplicationNetworkState.js +0 -48
- package/src/types/OcaBlockConfigurability.d.ts +26 -0
- package/src/types/OcaBlockConfigurability.js +35 -0
- package/src/types/OcaClassicalFilterShape.d.ts +1 -1
- package/src/types/OcaClassicalFilterShape.js +1 -1
- package/src/types/OcaCommand.d.ts +44 -0
- package/src/types/OcaCommand.js +25 -0
- package/src/types/OcaCommandResult.d.ts +42 -0
- package/src/types/OcaCommandResult.js +24 -0
- package/src/types/OcaCommandSetResult.d.ts +41 -0
- package/src/types/OcaCommandSetResult.js +23 -0
- package/src/types/OcaConstructionParameter.d.ts +40 -0
- package/src/types/OcaConstructionParameter.js +23 -0
- package/src/types/OcaCounter.d.ts +81 -0
- package/src/types/OcaCounter.js +38 -0
- package/src/types/OcaCounterNotifierFilterParameters.d.ts +81 -0
- package/src/types/OcaCounterNotifierFilterParameters.js +37 -0
- package/src/types/OcaCounterSet.d.ts +38 -0
- package/src/types/OcaCounterSet.js +22 -0
- package/src/types/OcaCounterUpdate.d.ts +54 -0
- package/src/types/OcaCounterUpdate.js +28 -0
- package/src/types/OcaCounterUpdateEventData.d.ts +27 -0
- package/src/types/OcaCounterUpdateEventData.js +17 -0
- package/src/types/OcaDatasetSearchResult.d.ts +51 -0
- package/src/types/OcaDatasetSearchResult.js +28 -0
- package/src/types/OcaDelayUnit.d.ts +2 -1
- package/src/types/OcaDelayUnit.js +2 -1
- package/src/types/OcaDelayValue.d.ts +2 -1
- package/src/types/OcaDelayValue.js +2 -1
- package/src/types/OcaDeviceGenericState.d.ts +62 -0
- package/src/types/OcaDeviceGenericState.js +52 -0
- package/src/types/OcaDeviceOperationalState.d.ts +42 -0
- package/src/types/OcaDeviceOperationalState.js +22 -0
- package/src/types/OcaDeviceState.d.ts +2 -2
- package/src/types/OcaDeviceState.js +2 -2
- package/src/types/OcaExecutableType.d.ts +50 -0
- package/src/types/OcaExecutableType.js +36 -0
- package/src/types/OcaGenericEndState.d.ts +56 -0
- package/src/types/OcaGenericEndState.js +44 -0
- package/src/types/OcaGlobalTypeIdentifier.d.ts +12 -12
- package/src/types/OcaGlobalTypeIdentifier.js +8 -7
- package/src/types/OcaGroupException.d.ts +53 -0
- package/src/types/OcaGroupException.js +28 -0
- package/src/types/OcaGrouperCitizen.d.ts +10 -10
- package/src/types/OcaGrouperCitizen.js +6 -6
- package/src/types/OcaGrouperEnrollment.d.ts +4 -9
- package/src/types/OcaGrouperEnrollment.js +3 -5
- package/src/types/OcaGrouperGroup.d.ts +9 -9
- package/src/types/OcaGrouperGroup.js +5 -5
- package/src/types/OcaGrouperMode.d.ts +4 -3
- package/src/types/OcaGrouperMode.js +4 -3
- package/src/types/OcaGrouperStatusChangeEventData.d.ts +2 -2
- package/src/types/OcaGrouperStatusChangeEventData.js +2 -2
- package/src/types/OcaGrouperStatusChangeType.d.ts +1 -1
- package/src/types/OcaGrouperStatusChangeType.js +1 -1
- package/src/types/OcaIODirection.d.ts +39 -0
- package/src/types/OcaIODirection.js +28 -0
- package/src/types/OcaIP4AutoconfigMode.d.ts +56 -0
- package/src/types/OcaIP4AutoconfigMode.js +44 -0
- package/src/types/OcaIP4Gateway.d.ts +53 -0
- package/src/types/OcaIP4Gateway.js +27 -0
- package/src/types/OcaIP4NetworkSettings.d.ts +111 -0
- package/src/types/OcaIP4NetworkSettings.js +56 -0
- package/src/types/OcaIP6AutoconfigMode.d.ts +56 -0
- package/src/types/OcaIP6AutoconfigMode.js +44 -0
- package/src/types/OcaIP6Gateway.d.ts +53 -0
- package/src/types/OcaIP6Gateway.js +27 -0
- package/src/types/OcaIP6NetworkSettings.d.ts +123 -0
- package/src/types/OcaIP6NetworkSettings.js +61 -0
- package/src/types/OcaInterval.d.ts +8 -0
- package/src/types/OcaInterval.js +84 -0
- package/src/types/OcaIntervalBounds.d.ts +41 -0
- package/src/types/OcaIntervalBounds.js +53 -0
- package/src/types/OcaJobDisposedEventData.d.ts +57 -0
- package/src/types/OcaJobDisposedEventData.js +28 -0
- package/src/types/OcaJobDisposition.d.ts +68 -0
- package/src/types/OcaJobDisposition.js +60 -0
- package/src/types/OcaJobQueueItem.d.ts +105 -0
- package/src/types/OcaJobQueueItem.js +44 -0
- package/src/types/OcaLibVolType.d.ts +2 -4
- package/src/types/OcaLibVolType.js +1 -2
- package/src/types/OcaLockState.d.ts +50 -0
- package/src/types/OcaLockState.js +36 -0
- package/src/types/OcaLogFilter.d.ts +70 -0
- package/src/types/OcaLogFilter.js +33 -0
- package/src/types/OcaLogRecord.d.ts +85 -0
- package/src/types/OcaLogRecord.js +40 -0
- package/src/types/OcaManagerDefaultObjectNumbers.d.ts +7 -0
- package/src/types/OcaManagerDefaultObjectNumbers.js +7 -0
- package/src/types/OcaManagerDescriptor.d.ts +11 -9
- package/src/types/OcaManagerDescriptor.js +6 -5
- package/src/types/OcaManufacturer.d.ts +87 -0
- package/src/types/OcaManufacturer.js +47 -0
- package/src/types/OcaMatrixCommand.d.ts +61 -0
- package/src/types/OcaMatrixCommand.js +29 -0
- package/src/types/OcaMatrixCoordinates.d.ts +38 -0
- package/src/types/OcaMatrixCoordinates.js +23 -0
- package/src/types/OcaMediaAccessMode.d.ts +50 -0
- package/src/types/OcaMediaAccessMode.js +36 -0
- package/src/types/OcaMediaClockAvailability.d.ts +1 -1
- package/src/types/OcaMediaClockAvailability.js +1 -1
- package/src/types/OcaMediaClockRate.d.ts +7 -7
- package/src/types/OcaMediaClockRate.js +4 -4
- package/src/types/OcaMediaConnection.d.ts +2 -2
- package/src/types/OcaMediaConnection.js +1 -1
- package/src/types/OcaMediaFrameFormat.d.ts +74 -0
- package/src/types/OcaMediaFrameFormat.js +68 -0
- package/src/types/OcaMediaPlayOption.d.ts +50 -0
- package/src/types/OcaMediaPlayOption.js +36 -0
- package/src/types/OcaMediaRecorderPlayerState.d.ts +62 -0
- package/src/types/OcaMediaRecorderPlayerState.js +52 -0
- package/src/types/OcaMediaStreamCastMode.d.ts +3 -3
- package/src/types/OcaMediaStreamCastMode.js +3 -3
- package/src/types/OcaMediaStreamEndpoint.d.ts +238 -0
- package/src/types/OcaMediaStreamEndpoint.js +114 -0
- package/src/types/OcaMediaStreamEndpointCommand.d.ts +80 -0
- package/src/types/OcaMediaStreamEndpointCommand.js +76 -0
- package/src/types/OcaMediaStreamEndpointState.d.ts +68 -0
- package/src/types/OcaMediaStreamEndpointState.js +60 -0
- package/src/types/OcaMediaStreamEndpointStatus.d.ts +44 -0
- package/src/types/OcaMediaStreamEndpointStatus.js +23 -0
- package/src/types/OcaMediaStreamMode.d.ts +83 -0
- package/src/types/OcaMediaStreamMode.js +43 -0
- package/src/types/OcaMediaStreamModeCapability.d.ts +167 -0
- package/src/types/OcaMediaStreamModeCapability.js +81 -0
- package/src/types/OcaMediaStreamModeCapabilityDirection.d.ts +21 -0
- package/src/types/OcaMediaStreamModeCapabilityDirection.js +27 -0
- package/src/types/OcaMediaTrackFunction.d.ts +27 -0
- package/src/types/OcaMediaTrackFunction.js +36 -0
- package/src/types/OcaMediaTransportSession.d.ts +119 -0
- package/src/types/OcaMediaTransportSession.js +58 -0
- package/src/types/OcaMediaTransportSessionConnection.d.ts +63 -0
- package/src/types/OcaMediaTransportSessionConnection.js +32 -0
- package/src/types/OcaMediaTransportSessionConnectionState.d.ts +47 -0
- package/src/types/OcaMediaTransportSessionConnectionState.js +24 -0
- package/src/types/OcaMediaTransportSessionState.d.ts +62 -0
- package/src/types/OcaMediaTransportSessionState.js +52 -0
- package/src/types/OcaMediaTransportSessionStatus.d.ts +43 -0
- package/src/types/OcaMediaTransportSessionStatus.js +23 -0
- package/src/types/OcaMediaTransportTimingParameters.d.ts +54 -0
- package/src/types/OcaMediaTransportTimingParameters.js +31 -0
- package/src/types/OcaMediaVolumePosition.d.ts +46 -0
- package/src/types/OcaMediaVolumePosition.js +23 -0
- package/src/types/OcaMediaVolumePositionType.d.ts +44 -0
- package/src/types/OcaMediaVolumePositionType.js +28 -0
- package/src/types/OcaModelGUID.d.ts +0 -1
- package/src/types/OcaModelGUID.js +0 -1
- package/src/types/OcaNetworkAdvertisingMechanism.d.ts +43 -0
- package/src/types/OcaNetworkAdvertisingMechanism.js +23 -0
- package/src/types/OcaNetworkAdvertisingService.d.ts +56 -0
- package/src/types/OcaNetworkAdvertisingService.js +44 -0
- package/src/types/OcaNetworkInterfaceAssignment.d.ts +99 -0
- package/src/types/OcaNetworkInterfaceAssignment.js +51 -0
- package/src/types/OcaNetworkInterfaceCommand.d.ts +50 -0
- package/src/types/OcaNetworkInterfaceCommand.js +36 -0
- package/src/types/OcaNetworkInterfaceState.d.ts +50 -0
- package/src/types/OcaNetworkInterfaceState.js +36 -0
- package/src/types/OcaNetworkInterfaceStatus.d.ts +42 -0
- package/src/types/OcaNetworkInterfaceStatus.js +22 -0
- package/src/types/OcaNotificationDeliveryMode.d.ts +13 -1
- package/src/types/OcaNotificationDeliveryMode.js +17 -1
- package/src/types/OcaOPath.d.ts +16 -2
- package/src/types/OcaOPath.js +8 -1
- package/src/types/OcaObjectListEventData.d.ts +2 -2
- package/src/types/OcaObjectListEventData.js +2 -2
- package/src/types/OcaObjectSearchResult.d.ts +4 -83
- package/src/types/OcaObjectSearchResult.js +2 -37
- package/src/types/OcaObjectSearchResultFlags.d.ts +4 -33
- package/src/types/OcaObjectSearchResultFlags.js +2 -48
- package/src/types/OcaObservationEventData.d.ts +2 -2
- package/src/types/OcaObservationEventData.js +2 -2
- package/src/types/OcaObservationListEventData.d.ts +2 -2
- package/src/types/OcaObservationListEventData.js +2 -2
- package/src/types/OcaObserverState.d.ts +1 -1
- package/src/types/OcaObserverState.js +1 -1
- package/src/types/OcaParameterMask.d.ts +81 -1
- package/src/types/OcaParameterMask.js +131 -1
- package/src/types/OcaPort.d.ts +7 -5
- package/src/types/OcaPort.js +4 -3
- package/src/types/OcaPortClockMapEntry.d.ts +42 -0
- package/src/types/OcaPortClockMapEntry.js +23 -0
- package/src/types/OcaPortID.d.ts +12 -10
- package/src/types/OcaPortID.js +7 -6
- package/src/types/OcaPortIdentification.d.ts +39 -0
- package/src/types/OcaPortIdentification.js +23 -0
- package/src/types/OcaPortMode.d.ts +4 -36
- package/src/types/OcaPortMode.js +2 -25
- package/src/types/OcaPositionDescriptor.d.ts +6 -6
- package/src/types/OcaPositionDescriptor.js +2 -2
- package/src/types/OcaPositionDescriptorFieldFlags.d.ts +33 -3
- package/src/types/OcaPositionDescriptorFieldFlags.js +53 -3
- package/src/types/OcaPowerSupplyState.d.ts +1 -1
- package/src/types/OcaPowerSupplyState.js +1 -1
- package/src/types/OcaProduct.d.ts +92 -0
- package/src/types/OcaProduct.js +42 -0
- package/src/types/OcaProgramResult.d.ts +39 -0
- package/src/types/OcaProgramResult.js +22 -0
- package/src/types/OcaProgramRunMode.d.ts +24 -0
- package/src/types/OcaProgramRunMode.js +30 -0
- package/src/types/OcaProperty.d.ts +2 -2
- package/src/types/OcaProperty.js +2 -2
- package/src/types/OcaProtoObjectIdentification.d.ts +1 -1
- package/src/types/OcaProtoObjectIdentification.js +1 -1
- package/src/types/OcaProtoPort.d.ts +16 -18
- package/src/types/OcaProtoPort.js +6 -8
- package/src/types/OcaProtoPortClockMapEntry.d.ts +46 -0
- package/src/types/OcaProtoPortClockMapEntry.js +25 -0
- package/src/types/OcaProtoSignalPath.d.ts +12 -10
- package/src/types/OcaProtoSignalPath.js +7 -6
- package/src/types/OcaRamperState.d.ts +19 -18
- package/src/types/OcaRamperState.js +19 -18
- package/src/types/OcaResetCause.d.ts +7 -1
- package/src/types/OcaResetCause.js +8 -0
- package/src/types/OcaSamplingRateConverterType.d.ts +50 -0
- package/src/types/OcaSamplingRateConverterType.js +36 -0
- package/src/types/OcaSecurityType.d.ts +39 -0
- package/src/types/OcaSecurityType.js +28 -0
- package/src/types/OcaSignalPath.d.ts +10 -10
- package/src/types/OcaSignalPath.js +6 -6
- package/src/types/OcaStatus.d.ts +19 -1
- package/src/types/OcaStatus.js +24 -0
- package/src/types/OcaStream.d.ts +2 -2
- package/src/types/OcaStream.js +1 -1
- package/src/types/OcaTask.d.ts +23 -24
- package/src/types/OcaTask.js +7 -7
- package/src/types/OcaTaskCommand.d.ts +2 -7
- package/src/types/OcaTaskCommand.js +2 -9
- package/src/types/OcaTaskExecutionTerminatedEventData.d.ts +64 -0
- package/src/types/OcaTaskExecutionTerminatedEventData.js +30 -0
- package/src/types/OcaTaskGenericState.d.ts +64 -0
- package/src/types/OcaTaskGenericState.js +54 -0
- package/src/types/OcaTaskManagerState.d.ts +1 -0
- package/src/types/OcaTaskManagerState.js +1 -0
- package/src/types/OcaTaskOperationalState.d.ts +43 -0
- package/src/types/OcaTaskOperationalState.js +22 -0
- package/src/types/OcaTaskSchedulerState.d.ts +63 -0
- package/src/types/OcaTaskSchedulerState.js +53 -0
- package/src/types/OcaTaskStatus.d.ts +2 -12
- package/src/types/OcaTaskStatus.js +2 -12
- package/src/types/OcaTaskStatusChangedEventData.d.ts +61 -0
- package/src/types/OcaTaskStatusChangedEventData.js +29 -0
- package/src/types/OcaTime.d.ts +56 -0
- package/src/types/OcaTime.js +32 -0
- package/src/types/OcaTimeDeliveryMechanism.d.ts +167 -0
- package/src/types/OcaTimeDeliveryMechanism.js +191 -0
- package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.d.ts +40 -0
- package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.js +24 -0
- package/src/types/OcaTimePTP.d.ts +4 -51
- package/src/types/OcaTimePTP.js +2 -28
- package/src/types/OcaTimeReferenceType.d.ts +7 -13
- package/src/types/OcaTimeReferenceType.js +6 -14
- package/src/types/OcaTimeSourceAvailability.d.ts +1 -1
- package/src/types/OcaTimeSourceAvailability.js +1 -1
- package/src/types/OcaTimeSourceSyncStatus.d.ts +1 -1
- package/src/types/OcaTimeSourceSyncStatus.js +1 -1
- package/src/types/OcaTransferFunction.d.ts +1 -1
- package/src/types/OcaTransferFunction.js +1 -1
- package/src/types/OcaTypedBlob.d.ts +40 -0
- package/src/types/OcaTypedBlob.js +24 -0
- package/src/types/OcaVariant.d.ts +19 -0
- package/src/types/OcaVariant.js +18 -0
- package/src/types/OcaWhenPhysicalAbsolute.d.ts +39 -0
- package/src/types/OcaWhenPhysicalAbsolute.js +22 -0
- package/src/types/OcaWhenPhysicalRelative.d.ts +39 -0
- package/src/types/OcaWhenPhysicalRelative.js +22 -0
|
@@ -3,13 +3,13 @@ import { RemoteDevice } from '../remote_device';
|
|
|
3
3
|
import { OcaManager } from './OcaManager';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* Optional manager that collects all
|
|
7
|
-
* which the device belongs.
|
|
6
|
+
* Optional manager that collects all network interface and network application
|
|
7
|
+
* objects to which the device belongs.
|
|
8
8
|
*
|
|
9
|
-
* - Must be instantiated
|
|
10
|
-
* object.
|
|
11
|
-
*
|
|
12
|
-
*
|
|
9
|
+
* - Must be instantiated in every device that has more than one network
|
|
10
|
+
* object.
|
|
11
|
+
*
|
|
12
|
+
* - May be instantiated at most once in any device.
|
|
13
13
|
*
|
|
14
14
|
* - If instantiated, must have object number 6.
|
|
15
15
|
*
|
|
@@ -38,12 +38,21 @@ export declare class OcaNetworkManager extends OcaManager {
|
|
|
38
38
|
*/
|
|
39
39
|
OnMediaTransportNetworksChanged: PropertyEvent<number[]>;
|
|
40
40
|
|
|
41
|
+
/**
|
|
42
|
+
* This event is emitted whenever NetworkInterfaces changes.
|
|
43
|
+
*/
|
|
44
|
+
OnNetworkInterfacesChanged: PropertyEvent<number[]>;
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* This event is emitted whenever NetworkApplications changes.
|
|
48
|
+
*/
|
|
49
|
+
OnNetworkApplicationsChanged: PropertyEvent<number[]>;
|
|
50
|
+
|
|
41
51
|
constructor(objectNumber: number, device: RemoteDevice);
|
|
42
52
|
|
|
43
53
|
/**
|
|
44
54
|
* Gets the list of object numbers of **OcaNetwork** instances in this device.
|
|
45
|
-
*
|
|
46
|
-
* **Deprecated as of OCA 1.2**
|
|
55
|
+
* **Deprecated** in version 2 of this class.
|
|
47
56
|
*
|
|
48
57
|
* @method OcaNetworkManager#GetNetworks
|
|
49
58
|
* @returns {Promise<number[]>}
|
|
@@ -52,9 +61,8 @@ export declare class OcaNetworkManager extends OcaManager {
|
|
|
52
61
|
GetNetworks(): Promise<number[]>;
|
|
53
62
|
|
|
54
63
|
/**
|
|
55
|
-
* Gets the list of object numbers of **OcaStreamNetwork**
|
|
56
|
-
* device.
|
|
57
|
-
* **Deprecated as of OCA 1.4.**
|
|
64
|
+
* Gets the list of object numbers of **OcaStreamNetwork** objects in this
|
|
65
|
+
* device. **Deprecated** in version 2 of this class.
|
|
58
66
|
*
|
|
59
67
|
* @method OcaNetworkManager#GetStreamNetworks
|
|
60
68
|
* @returns {Promise<number[]>}
|
|
@@ -63,9 +71,8 @@ export declare class OcaNetworkManager extends OcaManager {
|
|
|
63
71
|
GetStreamNetworks(): Promise<number[]>;
|
|
64
72
|
|
|
65
73
|
/**
|
|
66
|
-
* Gets the list of object numbers of **OcaControlNetwork**
|
|
67
|
-
* device.
|
|
68
|
-
* Introduced in version 1.4.
|
|
74
|
+
* Gets the list of object numbers of **OcaControlNetwork** objects in this
|
|
75
|
+
* device. **Deprecated** in version 3 of this class.
|
|
69
76
|
*
|
|
70
77
|
* @method OcaNetworkManager#GetControlNetworks
|
|
71
78
|
* @returns {Promise<number[]>}
|
|
@@ -74,13 +81,34 @@ export declare class OcaNetworkManager extends OcaManager {
|
|
|
74
81
|
GetControlNetworks(): Promise<number[]>;
|
|
75
82
|
|
|
76
83
|
/**
|
|
77
|
-
* Gets the list of object numbers of **OcaMediaTransportNetwork**
|
|
78
|
-
*
|
|
79
|
-
* retrieved. Introduced in version 1.4.
|
|
84
|
+
* Gets the list of object numbers of **OcaMediaTransportNetwork** objects in
|
|
85
|
+
* this device. **Deprecated** in version 3 of this class.
|
|
80
86
|
*
|
|
81
87
|
* @method OcaNetworkManager#GetMediaTransportNetworks
|
|
82
88
|
* @returns {Promise<number[]>}
|
|
83
89
|
* A promise which resolves to a single value of type ``number[]``.
|
|
84
90
|
*/
|
|
85
91
|
GetMediaTransportNetworks(): Promise<number[]>;
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Gets the list of object numbers of all objects that are instances of
|
|
95
|
+
* **OcaNetworkInterface** or a subclass of **OcaNetworkInterface.** Added in
|
|
96
|
+
* version 3 of this class.
|
|
97
|
+
*
|
|
98
|
+
* @method OcaNetworkManager#GetNetworkInterfaces
|
|
99
|
+
* @returns {Promise<number[]>}
|
|
100
|
+
* A promise which resolves to a single value of type ``number[]``.
|
|
101
|
+
*/
|
|
102
|
+
GetNetworkInterfaces(): Promise<number[]>;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Gets the list of object numbers of all objects that are instances of
|
|
106
|
+
* **OcaNetworkApplication** or a subclass of **OcaNetworkApplication.** Added
|
|
107
|
+
* in version 3 of this class.
|
|
108
|
+
*
|
|
109
|
+
* @method OcaNetworkManager#GetNetworkApplications
|
|
110
|
+
* @returns {Promise<number[]>}
|
|
111
|
+
* A promise which resolves to a single value of type ``number[]``.
|
|
112
|
+
*/
|
|
113
|
+
GetNetworkApplications(): Promise<number[]>;
|
|
86
114
|
}
|
|
@@ -4,13 +4,13 @@ import { make_control_class } from '../make_control_class.js';
|
|
|
4
4
|
import { OcaManager } from './OcaManager.js';
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Optional manager that collects all
|
|
8
|
-
* which the device belongs.
|
|
7
|
+
* Optional manager that collects all network interface and network application
|
|
8
|
+
* objects to which the device belongs.
|
|
9
9
|
*
|
|
10
|
-
* - Must be instantiated
|
|
11
|
-
* object.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* - Must be instantiated in every device that has more than one network
|
|
11
|
+
* object.
|
|
12
|
+
*
|
|
13
|
+
* - May be instantiated at most once in any device.
|
|
14
14
|
*
|
|
15
15
|
* - If instantiated, must have object number 6.
|
|
16
16
|
*
|
|
@@ -22,64 +22,82 @@ export const OcaNetworkManager = make_control_class(
|
|
|
22
22
|
'OcaNetworkManager',
|
|
23
23
|
3,
|
|
24
24
|
'\u0001\u0003\u0006',
|
|
25
|
-
|
|
25
|
+
3,
|
|
26
26
|
OcaManager,
|
|
27
27
|
[
|
|
28
28
|
['GetNetworks', 3, 1, [], [OcaList(OcaUint32)]],
|
|
29
29
|
['GetStreamNetworks', 3, 2, [], [OcaList(OcaUint32)]],
|
|
30
30
|
['GetControlNetworks', 3, 3, [], [OcaList(OcaUint32)]],
|
|
31
31
|
['GetMediaTransportNetworks', 3, 4, [], [OcaList(OcaUint32)]],
|
|
32
|
+
['GetNetworkInterfaces', 3, 5, [], [OcaList(OcaUint32)]],
|
|
33
|
+
['GetNetworkApplications', 3, 6, [], [OcaList(OcaUint32)]],
|
|
32
34
|
],
|
|
33
35
|
[
|
|
34
36
|
['Networks', [OcaList(OcaUint32)], 3, 1, false, false, null],
|
|
35
37
|
['StreamNetworks', [OcaList(OcaUint32)], 3, 2, false, false, null],
|
|
36
38
|
['ControlNetworks', [OcaList(OcaUint32)], 3, 3, false, false, null],
|
|
37
39
|
['MediaTransportNetworks', [OcaList(OcaUint32)], 3, 4, false, false, null],
|
|
40
|
+
['NetworkInterfaces', [OcaList(OcaUint32)], 3, 5, false, false, null],
|
|
41
|
+
['NetworkApplications', [OcaList(OcaUint32)], 3, 6, false, false, null],
|
|
38
42
|
],
|
|
39
43
|
[]
|
|
40
44
|
);
|
|
41
45
|
|
|
42
46
|
/**
|
|
43
47
|
* Gets the list of object numbers of **OcaNetwork** instances in this device.
|
|
44
|
-
*
|
|
45
|
-
* **Deprecated as of OCA 1.2**
|
|
48
|
+
* **Deprecated** in version 2 of this class.
|
|
46
49
|
*
|
|
47
50
|
* @method OcaNetworkManager#GetNetworks
|
|
48
51
|
* @returns {Promise<number[]>}
|
|
49
52
|
* A promise which resolves to a single value of type ``number[]``.
|
|
50
53
|
*/
|
|
51
54
|
/**
|
|
52
|
-
* Gets the list of object numbers of **OcaStreamNetwork**
|
|
53
|
-
* device.
|
|
54
|
-
* **Deprecated as of OCA 1.4.**
|
|
55
|
+
* Gets the list of object numbers of **OcaStreamNetwork** objects in this
|
|
56
|
+
* device. **Deprecated** in version 2 of this class.
|
|
55
57
|
*
|
|
56
58
|
* @method OcaNetworkManager#GetStreamNetworks
|
|
57
59
|
* @returns {Promise<number[]>}
|
|
58
60
|
* A promise which resolves to a single value of type ``number[]``.
|
|
59
61
|
*/
|
|
60
62
|
/**
|
|
61
|
-
* Gets the list of object numbers of **OcaControlNetwork**
|
|
62
|
-
* device.
|
|
63
|
-
* Introduced in version 1.4.
|
|
63
|
+
* Gets the list of object numbers of **OcaControlNetwork** objects in this
|
|
64
|
+
* device. **Deprecated** in version 3 of this class.
|
|
64
65
|
*
|
|
65
66
|
* @method OcaNetworkManager#GetControlNetworks
|
|
66
67
|
* @returns {Promise<number[]>}
|
|
67
68
|
* A promise which resolves to a single value of type ``number[]``.
|
|
68
69
|
*/
|
|
69
70
|
/**
|
|
70
|
-
* Gets the list of object numbers of **OcaMediaTransportNetwork**
|
|
71
|
-
* this device.
|
|
72
|
-
* Introduced in version 1.4.
|
|
71
|
+
* Gets the list of object numbers of **OcaMediaTransportNetwork** objects in
|
|
72
|
+
* this device. **Deprecated** in version 3 of this class.
|
|
73
73
|
*
|
|
74
74
|
* @method OcaNetworkManager#GetMediaTransportNetworks
|
|
75
75
|
* @returns {Promise<number[]>}
|
|
76
76
|
* A promise which resolves to a single value of type ``number[]``.
|
|
77
77
|
*/
|
|
78
|
+
/**
|
|
79
|
+
* Gets the list of object numbers of all objects that are instances of
|
|
80
|
+
* **OcaNetworkInterface** or a subclass of **OcaNetworkInterface.** Added in
|
|
81
|
+
* version 3 of this class.
|
|
82
|
+
*
|
|
83
|
+
* @method OcaNetworkManager#GetNetworkInterfaces
|
|
84
|
+
* @returns {Promise<number[]>}
|
|
85
|
+
* A promise which resolves to a single value of type ``number[]``.
|
|
86
|
+
*/
|
|
87
|
+
/**
|
|
88
|
+
* Gets the list of object numbers of all objects that are instances of
|
|
89
|
+
* **OcaNetworkApplication** or a subclass of **OcaNetworkApplication.** Added
|
|
90
|
+
* in version 3 of this class.
|
|
91
|
+
*
|
|
92
|
+
* @method OcaNetworkManager#GetNetworkApplications
|
|
93
|
+
* @returns {Promise<number[]>}
|
|
94
|
+
* A promise which resolves to a single value of type ``number[]``.
|
|
95
|
+
*/
|
|
78
96
|
/**
|
|
79
97
|
* This event is emitted when the property ``Networks`` changes in the remote object.
|
|
80
98
|
* The property ``Networks`` is described in the AES70 standard as follows.
|
|
81
99
|
* Object numbers of **OcaNetwork** objects, one for each network to which this
|
|
82
|
-
* device belongs. **Deprecated
|
|
100
|
+
* device belongs. **Deprecated** in version 2 of this class.
|
|
83
101
|
*
|
|
84
102
|
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnNetworksChanged
|
|
85
103
|
*/
|
|
@@ -87,7 +105,7 @@ export const OcaNetworkManager = make_control_class(
|
|
|
87
105
|
* This event is emitted when the property ``StreamNetworks`` changes in the remote object.
|
|
88
106
|
* The property ``StreamNetworks`` is described in the AES70 standard as follows.
|
|
89
107
|
* Object numbers of **OcaStreamNetwork** objects, one for each network to which
|
|
90
|
-
* this device belongs. **Deprecated
|
|
108
|
+
* this device belongs. **Deprecated** in version 3 of this class.
|
|
91
109
|
*
|
|
92
110
|
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnStreamNetworksChanged
|
|
93
111
|
*/
|
|
@@ -95,7 +113,7 @@ export const OcaNetworkManager = make_control_class(
|
|
|
95
113
|
* This event is emitted when the property ``ControlNetworks`` changes in the remote object.
|
|
96
114
|
* The property ``ControlNetworks`` is described in the AES70 standard as follows.
|
|
97
115
|
* Object numbers of **OcaControlNetwork** objects, one for each control network
|
|
98
|
-
* to which this device belongs.
|
|
116
|
+
* to which this device belongs. Deprecated in version 3 of this class.
|
|
99
117
|
*
|
|
100
118
|
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnControlNetworksChanged
|
|
101
119
|
*/
|
|
@@ -103,7 +121,26 @@ export const OcaNetworkManager = make_control_class(
|
|
|
103
121
|
* This event is emitted when the property ``MediaTransportNetworks`` changes in the remote object.
|
|
104
122
|
* The property ``MediaTransportNetworks`` is described in the AES70 standard as follows.
|
|
105
123
|
* Object numbers of **OcaMediaTransportNetwork** objects, one for each media
|
|
106
|
-
* transport network to which this device belongs.
|
|
124
|
+
* transport network to which this device belongs. Deprecated in version 3 of
|
|
125
|
+
* this class.
|
|
107
126
|
*
|
|
108
127
|
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnMediaTransportNetworksChanged
|
|
109
128
|
*/
|
|
129
|
+
/**
|
|
130
|
+
* This event is emitted when the property ``NetworkInterfaces`` changes in the remote object.
|
|
131
|
+
* The property ``NetworkInterfaces`` is described in the AES70 standard as follows.
|
|
132
|
+
* Object numbers of all objects in this device that are instances of
|
|
133
|
+
* **OcaNetworkInterface** or a subclass of **OcaNetworkInterface**. Added in
|
|
134
|
+
* version 3 of this class.
|
|
135
|
+
*
|
|
136
|
+
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnNetworkInterfacesChanged
|
|
137
|
+
*/
|
|
138
|
+
/**
|
|
139
|
+
* This event is emitted when the property ``NetworkApplications`` changes in the remote object.
|
|
140
|
+
* The property ``NetworkApplications`` is described in the AES70 standard as follows.
|
|
141
|
+
* Object numbers of all objects in this device that are instances of
|
|
142
|
+
* **OcaNetworkApplication** or a subclass of **OcaNetworkApplication**. Added
|
|
143
|
+
* in version 3 of this class.
|
|
144
|
+
*
|
|
145
|
+
* @member {PropertyEvent<number[]>} OcaNetworkManager#OnNetworkApplicationsChanged
|
|
146
|
+
*/
|
|
@@ -19,10 +19,10 @@ import { OcaAgent } from './OcaAgent';
|
|
|
19
19
|
* comparison condition. A selection of comparison operators is available.
|
|
20
20
|
* Such observations are called "asynchronous observations".
|
|
21
21
|
*
|
|
22
|
-
* - **Timer expiry**. The value of the** Period** property, if nonzero, is
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
22
|
+
* - **Timer expiry**. The value of the** Period** property, if nonzero, is the
|
|
23
|
+
* time interval for the recurrent timed emission of **Observation** events.
|
|
24
|
+
* Such events ("periodic observations") are emitted regardless of the target
|
|
25
|
+
* property's value.
|
|
26
26
|
*
|
|
27
27
|
* - **Combination of (1) and (2)**. If a numeric comparison and a nonzero
|
|
28
28
|
* period are both specified, then the **Observation** event is emitted when
|
|
@@ -39,27 +39,26 @@ import { OcaAgent } from './OcaAgent';
|
|
|
39
39
|
* - For signed integer targets, the threshold and target are both coerced to
|
|
40
40
|
* **OcaInt64** before comparing.
|
|
41
41
|
*
|
|
42
|
-
* - For boolean values, the threshold
|
|
42
|
+
* - For boolean values, the threshold threshold and target are both coerced to
|
|
43
43
|
* **OcaUint8**, True is assigned the value One, False is assigned the value
|
|
44
44
|
* Zero.
|
|
45
45
|
*
|
|
46
46
|
*
|
|
47
47
|
* Note that this coercion may result in rounding errors if the observed
|
|
48
|
-
* datatype is of type OcaUint64 or
|
|
48
|
+
* datatype is of type **OcaUint64** or **OcaInt64**. An **OcaNumericObserver**
|
|
49
49
|
* instance and the property it observes are bound at the time the
|
|
50
50
|
* **OcaNumericObserver** instance is constructed. For static devices,
|
|
51
51
|
* construction will occur during manufacture, or possibly during a subsequent
|
|
52
52
|
* hardware configuration step. For reconfigurable devices, construction might
|
|
53
53
|
* be done by online controllers as part of device configuration sessions. This
|
|
54
|
-
* class is normally used for monitoring
|
|
55
|
-
*
|
|
54
|
+
* class is normally used for monitoring sensor readings, but may be used
|
|
55
|
+
* equally well for watching workers' parameter settings.
|
|
56
56
|
* @extends OcaAgent
|
|
57
57
|
* @class OcaNumericObserver
|
|
58
58
|
*/
|
|
59
59
|
export declare class OcaNumericObserver extends OcaAgent {
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
62
|
-
* observation.
|
|
61
|
+
* Gets state of the Observer.
|
|
63
62
|
* @member OcaNumericObserver#OnObservation {Event}
|
|
64
63
|
*/
|
|
65
64
|
OnObservation: Event;
|
|
@@ -102,9 +101,8 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
102
101
|
|
|
103
102
|
/**
|
|
104
103
|
* Gets the value of the observed property that was reported by the most
|
|
105
|
-
* recently emitted Observation event. If the numeric observer has never
|
|
106
|
-
* emitted an Observation event, returns the IEEE not-a-number value.
|
|
107
|
-
* return status indicates whether the value has been successfully returned.
|
|
104
|
+
* recently emitted **Observation** event. If the numeric observer has never
|
|
105
|
+
* emitted an **Observation** event, returns the IEEE not-a-number value.
|
|
108
106
|
*
|
|
109
107
|
* @method OcaNumericObserver#GetLastObservation
|
|
110
108
|
* @returns {Promise<number>}
|
|
@@ -113,8 +111,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
113
111
|
GetLastObservation(): Promise<number>;
|
|
114
112
|
|
|
115
113
|
/**
|
|
116
|
-
* Gets the
|
|
117
|
-
* successfully retrieved.
|
|
114
|
+
* Gets the value of the **State** property.
|
|
118
115
|
*
|
|
119
116
|
* @method OcaNumericObserver#GetState
|
|
120
117
|
* @returns {Promise<OcaObserverState>}
|
|
@@ -123,9 +120,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
123
120
|
GetState(): Promise<OcaObserverState>;
|
|
124
121
|
|
|
125
122
|
/**
|
|
126
|
-
* Gets the identification of the property that the observer
|
|
127
|
-
* return value indicates whether the identification was successfully
|
|
128
|
-
* retrieved.
|
|
123
|
+
* Gets the identification of the property that the observer is observing.
|
|
129
124
|
*
|
|
130
125
|
* @method OcaNumericObserver#GetObservedProperty
|
|
131
126
|
* @returns {Promise<OcaProperty>}
|
|
@@ -134,8 +129,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
134
129
|
GetObservedProperty(): Promise<OcaProperty>;
|
|
135
130
|
|
|
136
131
|
/**
|
|
137
|
-
* Sets the identification of the property that the observer
|
|
138
|
-
* return value indicates whether the identification was successfully set.
|
|
132
|
+
* Sets the identification of the property that the observer shall observe.
|
|
139
133
|
*
|
|
140
134
|
* @method OcaNumericObserver#SetObservedProperty
|
|
141
135
|
* @param {IOcaProperty} property
|
|
@@ -145,8 +139,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
145
139
|
SetObservedProperty(property: IOcaProperty): Promise<void>;
|
|
146
140
|
|
|
147
141
|
/**
|
|
148
|
-
* Gets the value of the **Threshold** property.
|
|
149
|
-
* whether the threshold value was successfully retrieved.
|
|
142
|
+
* Gets the value of the **Threshold** property.
|
|
150
143
|
*
|
|
151
144
|
* @method OcaNumericObserver#GetThreshold
|
|
152
145
|
* @returns {Promise<number>}
|
|
@@ -155,8 +148,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
155
148
|
GetThreshold(): Promise<number>;
|
|
156
149
|
|
|
157
150
|
/**
|
|
158
|
-
* Sets the value of the **Threshold** property.
|
|
159
|
-
* whether the threshold value was successfully set.
|
|
151
|
+
* Sets the value of the **Threshold** property.
|
|
160
152
|
*
|
|
161
153
|
* @method OcaNumericObserver#SetThreshold
|
|
162
154
|
* @param {number} Threshold
|
|
@@ -166,8 +158,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
166
158
|
SetThreshold(Threshold: number): Promise<void>;
|
|
167
159
|
|
|
168
160
|
/**
|
|
169
|
-
* Gets the value of the **Operator** property.
|
|
170
|
-
* whether the property was successfully retrieved.
|
|
161
|
+
* Gets the value of the **Operator** property.
|
|
171
162
|
*
|
|
172
163
|
* @method OcaNumericObserver#GetOperator
|
|
173
164
|
* @returns {Promise<OcaRelationalOperator>}
|
|
@@ -176,8 +167,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
176
167
|
GetOperator(): Promise<OcaRelationalOperator>;
|
|
177
168
|
|
|
178
169
|
/**
|
|
179
|
-
* Sets the value of the **Operator** property.
|
|
180
|
-
* whether the operator was successfully set.
|
|
170
|
+
* Sets the value of the **Operator** property.
|
|
181
171
|
*
|
|
182
172
|
* @method OcaNumericObserver#SetOperator
|
|
183
173
|
* @param {IOcaRelationalOperator} operator
|
|
@@ -187,8 +177,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
187
177
|
SetOperator(operator: IOcaRelationalOperator): Promise<void>;
|
|
188
178
|
|
|
189
179
|
/**
|
|
190
|
-
* Gets the value of the **TwoWay** property.
|
|
191
|
-
* whether the property was successfully retrieved.
|
|
180
|
+
* Gets the value of the **TwoWay** property.
|
|
192
181
|
*
|
|
193
182
|
* @method OcaNumericObserver#GetTwoWay
|
|
194
183
|
* @returns {Promise<boolean>}
|
|
@@ -197,8 +186,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
197
186
|
GetTwoWay(): Promise<boolean>;
|
|
198
187
|
|
|
199
188
|
/**
|
|
200
|
-
* Sets the value of the **TwoWay** property.
|
|
201
|
-
* whether the property was successfully set.
|
|
189
|
+
* Sets the value of the **TwoWay** property.
|
|
202
190
|
*
|
|
203
191
|
* @method OcaNumericObserver#SetTwoWay
|
|
204
192
|
* @param {boolean} twoWay
|
|
@@ -208,8 +196,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
208
196
|
SetTwoWay(twoWay: boolean): Promise<void>;
|
|
209
197
|
|
|
210
198
|
/**
|
|
211
|
-
* Gets the value of the **Hysteresis** property.
|
|
212
|
-
* whether the property was successfully retrieved.
|
|
199
|
+
* Gets the value of the **Hysteresis** property.
|
|
213
200
|
*
|
|
214
201
|
* @method OcaNumericObserver#GetHysteresis
|
|
215
202
|
* @returns {Promise<number>}
|
|
@@ -218,8 +205,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
218
205
|
GetHysteresis(): Promise<number>;
|
|
219
206
|
|
|
220
207
|
/**
|
|
221
|
-
* Sets the value of the **Hysteresis** property.
|
|
222
|
-
* whether the property was successfully set.
|
|
208
|
+
* Sets the value of the **Hysteresis** property.
|
|
223
209
|
*
|
|
224
210
|
* @method OcaNumericObserver#SetHysteresis
|
|
225
211
|
* @param {number} hysteresis
|
|
@@ -229,8 +215,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
229
215
|
SetHysteresis(hysteresis: number): Promise<void>;
|
|
230
216
|
|
|
231
217
|
/**
|
|
232
|
-
* Gets the value of the **Period** property.
|
|
233
|
-
* whether the property was successfully retrieved.
|
|
218
|
+
* Gets the value of the **Period** property.
|
|
234
219
|
*
|
|
235
220
|
* @method OcaNumericObserver#GetPeriod
|
|
236
221
|
* @returns {Promise<number>}
|
|
@@ -239,8 +224,7 @@ export declare class OcaNumericObserver extends OcaAgent {
|
|
|
239
224
|
GetPeriod(): Promise<number>;
|
|
240
225
|
|
|
241
226
|
/**
|
|
242
|
-
* Sets the value of the **Period** property.
|
|
243
|
-
* whether the property was successfully set.
|
|
227
|
+
* Sets the value of the **Period** property.
|
|
244
228
|
*
|
|
245
229
|
* @method OcaNumericObserver#SetPeriod
|
|
246
230
|
* @param {number} period
|
|
@@ -18,10 +18,10 @@ import { OcaAgent } from './OcaAgent.js';
|
|
|
18
18
|
* comparison condition. A selection of comparison operators is available.
|
|
19
19
|
* Such observations are called "asynchronous observations".
|
|
20
20
|
*
|
|
21
|
-
* - **Timer expiry**. The value of the** Period** property, if nonzero, is
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
21
|
+
* - **Timer expiry**. The value of the** Period** property, if nonzero, is the
|
|
22
|
+
* time interval for the recurrent timed emission of **Observation** events.
|
|
23
|
+
* Such events ("periodic observations") are emitted regardless of the target
|
|
24
|
+
* property's value.
|
|
25
25
|
*
|
|
26
26
|
* - **Combination of (1) and (2)**. If a numeric comparison and a nonzero
|
|
27
27
|
* period are both specified, then the **Observation** event is emitted when
|
|
@@ -38,20 +38,20 @@ import { OcaAgent } from './OcaAgent.js';
|
|
|
38
38
|
* - For signed integer targets, the threshold and target are both coerced to
|
|
39
39
|
* **OcaInt64** before comparing.
|
|
40
40
|
*
|
|
41
|
-
* - For boolean values, the threshold
|
|
41
|
+
* - For boolean values, the threshold threshold and target are both coerced to
|
|
42
42
|
* **OcaUint8**, True is assigned the value One, False is assigned the value
|
|
43
43
|
* Zero.
|
|
44
44
|
*
|
|
45
45
|
*
|
|
46
46
|
* Note that this coercion may result in rounding errors if the observed
|
|
47
|
-
* datatype is of type OcaUint64 or
|
|
47
|
+
* datatype is of type **OcaUint64** or **OcaInt64**. An **OcaNumericObserver**
|
|
48
48
|
* instance and the property it observes are bound at the time the
|
|
49
49
|
* **OcaNumericObserver** instance is constructed. For static devices,
|
|
50
50
|
* construction will occur during manufacture, or possibly during a subsequent
|
|
51
51
|
* hardware configuration step. For reconfigurable devices, construction might
|
|
52
52
|
* be done by online controllers as part of device configuration sessions. This
|
|
53
|
-
* class is normally used for monitoring
|
|
54
|
-
*
|
|
53
|
+
* class is normally used for monitoring sensor readings, but may be used
|
|
54
|
+
* equally well for watching workers' parameter settings.
|
|
55
55
|
* @extends OcaAgent
|
|
56
56
|
* @class OcaNumericObserver
|
|
57
57
|
*/
|
|
@@ -59,7 +59,7 @@ export const OcaNumericObserver = make_control_class(
|
|
|
59
59
|
'OcaNumericObserver',
|
|
60
60
|
3,
|
|
61
61
|
'\u0001\u0002\u0004',
|
|
62
|
-
|
|
62
|
+
3,
|
|
63
63
|
OcaAgent,
|
|
64
64
|
[
|
|
65
65
|
['GetLastObservation', 3, 1, [], [OcaFloat64]],
|
|
@@ -91,33 +91,29 @@ export const OcaNumericObserver = make_control_class(
|
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
93
|
* Gets the value of the observed property that was reported by the most
|
|
94
|
-
* recently emitted Observation event. If the numeric observer has never
|
|
95
|
-
* an Observation event, returns the IEEE not-a-number value.
|
|
96
|
-
* indicates whether the value has been successfully returned.
|
|
94
|
+
* recently emitted **Observation** event. If the numeric observer has never
|
|
95
|
+
* emitted an **Observation** event, returns the IEEE not-a-number value.
|
|
97
96
|
*
|
|
98
97
|
* @method OcaNumericObserver#GetLastObservation
|
|
99
98
|
* @returns {Promise<number>}
|
|
100
99
|
* A promise which resolves to a single value of type ``number``.
|
|
101
100
|
*/
|
|
102
101
|
/**
|
|
103
|
-
* Gets the
|
|
104
|
-
* successfully retrieved.
|
|
102
|
+
* Gets the value of the **State** property.
|
|
105
103
|
*
|
|
106
104
|
* @method OcaNumericObserver#GetState
|
|
107
105
|
* @returns {Promise<OcaObserverState>}
|
|
108
106
|
* A promise which resolves to a single value of type :class:`OcaObserverState`.
|
|
109
107
|
*/
|
|
110
108
|
/**
|
|
111
|
-
* Gets the identification of the property that the observer
|
|
112
|
-
* return value indicates whether the identification was successfully retrieved.
|
|
109
|
+
* Gets the identification of the property that the observer is observing.
|
|
113
110
|
*
|
|
114
111
|
* @method OcaNumericObserver#GetObservedProperty
|
|
115
112
|
* @returns {Promise<OcaProperty>}
|
|
116
113
|
* A promise which resolves to a single value of type :class:`OcaProperty`.
|
|
117
114
|
*/
|
|
118
115
|
/**
|
|
119
|
-
* Sets the identification of the property that the observer
|
|
120
|
-
* return value indicates whether the identification was successfully set.
|
|
116
|
+
* Sets the identification of the property that the observer shall observe.
|
|
121
117
|
*
|
|
122
118
|
* @method OcaNumericObserver#SetObservedProperty
|
|
123
119
|
* @param {IOcaProperty} property
|
|
@@ -125,16 +121,14 @@ export const OcaNumericObserver = make_control_class(
|
|
|
125
121
|
* @returns {Promise<void>}
|
|
126
122
|
*/
|
|
127
123
|
/**
|
|
128
|
-
* Gets the value of the **Threshold** property.
|
|
129
|
-
* whether the threshold value was successfully retrieved.
|
|
124
|
+
* Gets the value of the **Threshold** property.
|
|
130
125
|
*
|
|
131
126
|
* @method OcaNumericObserver#GetThreshold
|
|
132
127
|
* @returns {Promise<number>}
|
|
133
128
|
* A promise which resolves to a single value of type ``number``.
|
|
134
129
|
*/
|
|
135
130
|
/**
|
|
136
|
-
* Sets the value of the **Threshold** property.
|
|
137
|
-
* whether the threshold value was successfully set.
|
|
131
|
+
* Sets the value of the **Threshold** property.
|
|
138
132
|
*
|
|
139
133
|
* @method OcaNumericObserver#SetThreshold
|
|
140
134
|
* @param {number} Threshold
|
|
@@ -142,16 +136,14 @@ export const OcaNumericObserver = make_control_class(
|
|
|
142
136
|
* @returns {Promise<void>}
|
|
143
137
|
*/
|
|
144
138
|
/**
|
|
145
|
-
* Gets the value of the **Operator** property.
|
|
146
|
-
* whether the property was successfully retrieved.
|
|
139
|
+
* Gets the value of the **Operator** property.
|
|
147
140
|
*
|
|
148
141
|
* @method OcaNumericObserver#GetOperator
|
|
149
142
|
* @returns {Promise<OcaRelationalOperator>}
|
|
150
143
|
* A promise which resolves to a single value of type :class:`OcaRelationalOperator`.
|
|
151
144
|
*/
|
|
152
145
|
/**
|
|
153
|
-
* Sets the value of the **Operator** property.
|
|
154
|
-
* whether the operator was successfully set.
|
|
146
|
+
* Sets the value of the **Operator** property.
|
|
155
147
|
*
|
|
156
148
|
* @method OcaNumericObserver#SetOperator
|
|
157
149
|
* @param {IOcaRelationalOperator} operator
|
|
@@ -159,16 +151,14 @@ export const OcaNumericObserver = make_control_class(
|
|
|
159
151
|
* @returns {Promise<void>}
|
|
160
152
|
*/
|
|
161
153
|
/**
|
|
162
|
-
* Gets the value of the **TwoWay** property.
|
|
163
|
-
* the property was successfully retrieved.
|
|
154
|
+
* Gets the value of the **TwoWay** property.
|
|
164
155
|
*
|
|
165
156
|
* @method OcaNumericObserver#GetTwoWay
|
|
166
157
|
* @returns {Promise<boolean>}
|
|
167
158
|
* A promise which resolves to a single value of type ``boolean``.
|
|
168
159
|
*/
|
|
169
160
|
/**
|
|
170
|
-
* Sets the value of the **TwoWay** property.
|
|
171
|
-
* the property was successfully set.
|
|
161
|
+
* Sets the value of the **TwoWay** property.
|
|
172
162
|
*
|
|
173
163
|
* @method OcaNumericObserver#SetTwoWay
|
|
174
164
|
* @param {boolean} twoWay
|
|
@@ -176,16 +166,14 @@ export const OcaNumericObserver = make_control_class(
|
|
|
176
166
|
* @returns {Promise<void>}
|
|
177
167
|
*/
|
|
178
168
|
/**
|
|
179
|
-
* Gets the value of the **Hysteresis** property.
|
|
180
|
-
* whether the property was successfully retrieved.
|
|
169
|
+
* Gets the value of the **Hysteresis** property.
|
|
181
170
|
*
|
|
182
171
|
* @method OcaNumericObserver#GetHysteresis
|
|
183
172
|
* @returns {Promise<number>}
|
|
184
173
|
* A promise which resolves to a single value of type ``number``.
|
|
185
174
|
*/
|
|
186
175
|
/**
|
|
187
|
-
* Sets the value of the **Hysteresis** property.
|
|
188
|
-
* whether the property was successfully set.
|
|
176
|
+
* Sets the value of the **Hysteresis** property.
|
|
189
177
|
*
|
|
190
178
|
* @method OcaNumericObserver#SetHysteresis
|
|
191
179
|
* @param {number} hysteresis
|
|
@@ -193,16 +181,14 @@ export const OcaNumericObserver = make_control_class(
|
|
|
193
181
|
* @returns {Promise<void>}
|
|
194
182
|
*/
|
|
195
183
|
/**
|
|
196
|
-
* Gets the value of the **Period** property.
|
|
197
|
-
* the property was successfully retrieved.
|
|
184
|
+
* Gets the value of the **Period** property.
|
|
198
185
|
*
|
|
199
186
|
* @method OcaNumericObserver#GetPeriod
|
|
200
187
|
* @returns {Promise<number>}
|
|
201
188
|
* A promise which resolves to a single value of type ``number``.
|
|
202
189
|
*/
|
|
203
190
|
/**
|
|
204
|
-
* Sets the value of the **Period** property.
|
|
205
|
-
* the property was successfully set.
|
|
191
|
+
* Sets the value of the **Period** property.
|
|
206
192
|
*
|
|
207
193
|
* @method OcaNumericObserver#SetPeriod
|
|
208
194
|
* @param {number} period
|
|
@@ -210,8 +196,7 @@ export const OcaNumericObserver = make_control_class(
|
|
|
210
196
|
* @returns {Promise<void>}
|
|
211
197
|
*/
|
|
212
198
|
/**
|
|
213
|
-
*
|
|
214
|
-
* observation.
|
|
199
|
+
* Gets state of the Observer.
|
|
215
200
|
* @member OcaNumericObserver#OnObservation {Event}
|
|
216
201
|
*/
|
|
217
202
|
/**
|