aes70 1.6.2 → 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.
Files changed (651) hide show
  1. package/COPYING +7 -7
  2. package/Changelog +9 -0
  3. package/README.md +74 -42
  4. package/dist/AES70.es5.js +23882 -5157
  5. package/package.json +3 -3
  6. package/src/OCP1/Arguments.js +3 -0
  7. package/src/OCP1/Enum.js +8 -0
  8. package/src/OCP1/OcaActionObjectSearchResult.js +20 -0
  9. package/src/OCP1/OcaActionObjectSearchResultFlags.js +3 -0
  10. package/src/OCP1/OcaArray1D.js +108 -0
  11. package/src/OCP1/OcaBitstring.js +3 -0
  12. package/src/OCP1/OcaBlob.js +2 -43
  13. package/src/OCP1/OcaBlobFixedLen.js +8 -0
  14. package/src/OCP1/OcaBlockConfigurability.js +3 -0
  15. package/src/OCP1/OcaBoolean.js +3 -0
  16. package/src/OCP1/OcaCommand.js +17 -0
  17. package/src/OCP1/OcaCommandResult.js +17 -0
  18. package/src/OCP1/OcaCommandSetResult.js +17 -0
  19. package/src/OCP1/OcaConstructionParameter.js +16 -0
  20. package/src/OCP1/OcaCounter.js +22 -0
  21. package/src/OCP1/OcaCounterNotifierFilterParameters.js +19 -0
  22. package/src/OCP1/OcaCounterSet.js +17 -0
  23. package/src/OCP1/OcaCounterUpdate.js +18 -0
  24. package/src/OCP1/OcaCounterUpdateEventData.js +15 -0
  25. package/src/OCP1/OcaDatasetSearchResult.js +17 -0
  26. package/src/OCP1/OcaDeviceGenericState.js +4 -0
  27. package/src/OCP1/OcaDeviceOperationalState.js +16 -0
  28. package/src/OCP1/OcaExecutableType.js +4 -0
  29. package/src/OCP1/OcaFloat32.js +3 -0
  30. package/src/OCP1/OcaFloat64.js +3 -0
  31. package/src/OCP1/OcaGenericEndState.js +4 -0
  32. package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
  33. package/src/OCP1/OcaGroupException.js +18 -0
  34. package/src/OCP1/OcaIODirection.js +4 -0
  35. package/src/OCP1/OcaIP4AutoconfigMode.js +4 -0
  36. package/src/OCP1/OcaIP4Gateway.js +17 -0
  37. package/src/OCP1/OcaIP4NetworkSettings.js +23 -0
  38. package/src/OCP1/OcaIP6AutoconfigMode.js +4 -0
  39. package/src/OCP1/OcaIP6Gateway.js +17 -0
  40. package/src/OCP1/OcaIP6NetworkSettings.js +24 -0
  41. package/src/OCP1/OcaInt16.js +3 -0
  42. package/src/OCP1/OcaInt32.js +3 -0
  43. package/src/OCP1/OcaInt64.js +3 -0
  44. package/src/OCP1/OcaInt8.js +3 -0
  45. package/src/OCP1/OcaInterval.js +18 -0
  46. package/src/OCP1/OcaIntervalBounds.js +3 -0
  47. package/src/OCP1/OcaJobDisposedEventData.js +18 -0
  48. package/src/OCP1/OcaJobDisposition.js +4 -0
  49. package/src/OCP1/OcaJobQueueItem.js +24 -0
  50. package/src/OCP1/OcaList.js +2 -127
  51. package/src/OCP1/OcaList2D.js +6 -0
  52. package/src/OCP1/OcaList32.js +3 -0
  53. package/src/OCP1/OcaLockState.js +4 -0
  54. package/src/OCP1/OcaLogFilter.js +20 -0
  55. package/src/OCP1/OcaLogRecord.js +21 -0
  56. package/src/OCP1/OcaLongBlob.js +3 -0
  57. package/src/OCP1/OcaManufacturer.js +19 -0
  58. package/src/OCP1/OcaMap.js +3 -0
  59. package/src/OCP1/OcaMatrixCommand.js +19 -0
  60. package/src/OCP1/OcaMatrixCoordinates.js +15 -0
  61. package/src/OCP1/OcaMediaAccessMode.js +4 -0
  62. package/src/OCP1/OcaMediaFrameFormat.js +4 -0
  63. package/src/OCP1/OcaMediaPlayOption.js +4 -0
  64. package/src/OCP1/OcaMediaRecorderPlayerState.js +4 -0
  65. package/src/OCP1/OcaMediaStreamEndpoint.js +40 -0
  66. package/src/OCP1/OcaMediaStreamEndpointCommand.js +4 -0
  67. package/src/OCP1/OcaMediaStreamEndpointState.js +4 -0
  68. package/src/OCP1/OcaMediaStreamEndpointStatus.js +16 -0
  69. package/src/OCP1/OcaMediaStreamMode.js +21 -0
  70. package/src/OCP1/OcaMediaStreamModeCapability.js +29 -0
  71. package/src/OCP1/OcaMediaStreamModeCapabilityDirection.js +3 -0
  72. package/src/OCP1/OcaMediaTrackFunction.js +3 -0
  73. package/src/OCP1/OcaMediaTransportSession.js +30 -0
  74. package/src/OCP1/OcaMediaTransportSessionConnection.js +17 -0
  75. package/src/OCP1/OcaMediaTransportSessionConnectionState.js +15 -0
  76. package/src/OCP1/OcaMediaTransportSessionState.js +4 -0
  77. package/src/OCP1/OcaMediaTransportSessionStatus.js +16 -0
  78. package/src/OCP1/OcaMediaTransportTimingParameters.js +16 -0
  79. package/src/OCP1/OcaMediaVolumePosition.js +16 -0
  80. package/src/OCP1/OcaMediaVolumePositionType.js +4 -0
  81. package/src/OCP1/OcaMultiMap.js +3 -0
  82. package/src/OCP1/OcaNetworkAdvertisingMechanism.js +16 -0
  83. package/src/OCP1/OcaNetworkAdvertisingService.js +4 -0
  84. package/src/OCP1/OcaNetworkInterfaceAssignment.js +23 -0
  85. package/src/OCP1/OcaNetworkInterfaceCommand.js +4 -0
  86. package/src/OCP1/OcaNetworkInterfaceState.js +4 -0
  87. package/src/OCP1/OcaNetworkInterfaceStatus.js +16 -0
  88. package/src/OCP1/OcaObjectSearchResult.js +2 -18
  89. package/src/OCP1/OcaObjectSearchResultFlags.js +5 -3
  90. package/src/OCP1/OcaPort.js +1 -1
  91. package/src/OCP1/OcaPortClockMapEntry.js +16 -0
  92. package/src/OCP1/OcaPortID.js +2 -2
  93. package/src/OCP1/OcaPortIdentification.js +16 -0
  94. package/src/OCP1/OcaPortMode.js +5 -4
  95. package/src/OCP1/OcaPositionDescriptor.js +2 -2
  96. package/src/OCP1/OcaProduct.js +19 -0
  97. package/src/OCP1/OcaProgramResult.js +17 -0
  98. package/src/OCP1/OcaProgramRunMode.js +3 -0
  99. package/src/OCP1/OcaProtoPort.js +2 -2
  100. package/src/OCP1/OcaProtoPortClockMapEntry.js +17 -0
  101. package/src/OCP1/OcaProtoSignalPath.js +2 -2
  102. package/src/OCP1/OcaSamplingRateConverterType.js +4 -0
  103. package/src/OCP1/OcaSecurityType.js +4 -0
  104. package/src/OCP1/OcaSignalPath.js +2 -2
  105. package/src/OCP1/OcaString.js +3 -0
  106. package/src/OCP1/OcaTask.js +4 -3
  107. package/src/OCP1/OcaTaskExecutionTerminatedEventData.js +20 -0
  108. package/src/OCP1/OcaTaskGenericState.js +4 -0
  109. package/src/OCP1/OcaTaskOperationalState.js +17 -0
  110. package/src/OCP1/OcaTaskSchedulerState.js +4 -0
  111. package/src/OCP1/OcaTaskStatusChangedEventData.js +18 -0
  112. package/src/OCP1/OcaTime.js +18 -0
  113. package/src/OCP1/OcaTimeDeliveryMechanism.js +4 -0
  114. package/src/OCP1/OcaTimeDeliveryParameters_StreamEndpoint.js +15 -0
  115. package/src/OCP1/OcaTimePTP.js +2 -15
  116. package/src/OCP1/OcaTypedBlob.js +16 -0
  117. package/src/OCP1/OcaUint16.js +3 -0
  118. package/src/OCP1/OcaUint32.js +3 -0
  119. package/src/OCP1/OcaUint64.js +3 -0
  120. package/src/OCP1/OcaUint8.js +3 -0
  121. package/src/OCP1/OcaVariant.js +92 -0
  122. package/src/OCP1/OcaWhenPhysicalAbsolute.js +16 -0
  123. package/src/OCP1/OcaWhenPhysicalRelative.js +16 -0
  124. package/src/OCP1/RestWithOffset.js +3 -0
  125. package/src/OCP1/String16.js +3 -0
  126. package/src/OCP1/Struct.js +12 -0
  127. package/src/OCP1/Tuple.js +3 -0
  128. package/src/OCP1/createBlobType.js +58 -0
  129. package/src/OCP1/createListType.js +137 -0
  130. package/src/OCP1/createType.js +8 -4
  131. package/src/OCP1/decode_message.js +10 -2
  132. package/src/OCP1/encode_message.js +5 -1
  133. package/src/OCP1/getLengthEncoder.js +23 -0
  134. package/src/OCP1/notification2.js +70 -0
  135. package/src/OCP1/protocol_version.js +4 -0
  136. package/src/connection.js +14 -6
  137. package/src/controller/ControlClasses/OcaActuator.d.ts +3 -3
  138. package/src/controller/ControlClasses/OcaActuator.js +4 -4
  139. package/src/controller/ControlClasses/OcaAgent.d.ts +6 -14
  140. package/src/controller/ControlClasses/OcaAgent.js +8 -18
  141. package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +9 -17
  142. package/src/controller/ControlClasses/OcaApplicationNetwork.js +11 -32
  143. package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +4 -7
  144. package/src/controller/ControlClasses/OcaAudioLevelSensor.js +5 -8
  145. package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +1 -1
  146. package/src/controller/ControlClasses/OcaAudioProcessingManager.js +2 -2
  147. package/src/controller/ControlClasses/OcaBasicActuator.d.ts +1 -1
  148. package/src/controller/ControlClasses/OcaBasicActuator.js +2 -2
  149. package/src/controller/ControlClasses/OcaBasicSensor.d.ts +1 -1
  150. package/src/controller/ControlClasses/OcaBasicSensor.js +2 -2
  151. package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +34 -13
  152. package/src/controller/ControlClasses/OcaBitstringActuator.js +35 -18
  153. package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +19 -7
  154. package/src/controller/ControlClasses/OcaBitstringSensor.js +22 -12
  155. package/src/controller/ControlClasses/OcaBlock.d.ts +455 -89
  156. package/src/controller/ControlClasses/OcaBlock.js +477 -103
  157. package/src/controller/ControlClasses/OcaBlockFactoryAgent.d.ts +299 -0
  158. package/src/controller/ControlClasses/OcaBlockFactoryAgent.js +360 -0
  159. package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +2 -4
  160. package/src/controller/ControlClasses/OcaBooleanActuator.js +3 -5
  161. package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +2 -3
  162. package/src/controller/ControlClasses/OcaBooleanSensor.js +3 -4
  163. package/src/controller/ControlClasses/OcaCodingManager.js +1 -1
  164. package/src/controller/ControlClasses/OcaCommandSet.d.ts +89 -0
  165. package/src/controller/ControlClasses/OcaCommandSet.js +94 -0
  166. package/src/controller/ControlClasses/OcaCommandSetAgent.d.ts +31 -0
  167. package/src/controller/ControlClasses/OcaCommandSetAgent.js +38 -0
  168. package/src/controller/ControlClasses/OcaCounterNotifier.d.ts +89 -0
  169. package/src/controller/ControlClasses/OcaCounterNotifier.js +101 -0
  170. package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +2 -3
  171. package/src/controller/ControlClasses/OcaCurrentSensor.js +3 -4
  172. package/src/controller/ControlClasses/OcaDataset.d.ts +223 -0
  173. package/src/controller/ControlClasses/OcaDataset.js +234 -0
  174. package/src/controller/ControlClasses/OcaDatasetWorker.d.ts +31 -0
  175. package/src/controller/ControlClasses/OcaDatasetWorker.js +40 -0
  176. package/src/controller/ControlClasses/OcaDelay.d.ts +2 -4
  177. package/src/controller/ControlClasses/OcaDelay.js +3 -5
  178. package/src/controller/ControlClasses/OcaDelayExtended.d.ts +5 -7
  179. package/src/controller/ControlClasses/OcaDelayExtended.js +6 -8
  180. package/src/controller/ControlClasses/OcaDeviceManager.d.ts +123 -62
  181. package/src/controller/ControlClasses/OcaDeviceManager.js +161 -83
  182. package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +43 -25
  183. package/src/controller/ControlClasses/OcaDeviceTimeManager.js +43 -28
  184. package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +1 -13
  185. package/src/controller/ControlClasses/OcaDiagnosticManager.js +3 -16
  186. package/src/controller/ControlClasses/OcaDynamics.d.ts +38 -63
  187. package/src/controller/ControlClasses/OcaDynamics.js +48 -71
  188. package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +169 -82
  189. package/src/controller/ControlClasses/OcaDynamicsCurve.js +189 -93
  190. package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +8 -16
  191. package/src/controller/ControlClasses/OcaDynamicsDetector.js +9 -17
  192. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +5 -7
  193. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +10 -12
  194. package/src/controller/ControlClasses/OcaFilterClassical.d.ts +15 -26
  195. package/src/controller/ControlClasses/OcaFilterClassical.js +15 -27
  196. package/src/controller/ControlClasses/OcaFilterFIR.d.ts +6 -11
  197. package/src/controller/ControlClasses/OcaFilterFIR.js +12 -18
  198. package/src/controller/ControlClasses/OcaFilterParametric.d.ts +55 -26
  199. package/src/controller/ControlClasses/OcaFilterParametric.js +63 -32
  200. package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +5 -4
  201. package/src/controller/ControlClasses/OcaFilterPolynomial.js +8 -7
  202. package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +6 -11
  203. package/src/controller/ControlClasses/OcaFirmwareManager.js +5 -11
  204. package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +3 -5
  205. package/src/controller/ControlClasses/OcaFloat32Actuator.js +4 -6
  206. package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +2 -3
  207. package/src/controller/ControlClasses/OcaFloat32Sensor.js +3 -4
  208. package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +3 -5
  209. package/src/controller/ControlClasses/OcaFloat64Actuator.js +4 -6
  210. package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +2 -3
  211. package/src/controller/ControlClasses/OcaFloat64Sensor.js +3 -4
  212. package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +2 -4
  213. package/src/controller/ControlClasses/OcaFrequencyActuator.js +3 -5
  214. package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +1 -2
  215. package/src/controller/ControlClasses/OcaFrequencySensor.js +2 -3
  216. package/src/controller/ControlClasses/OcaGain.d.ts +2 -4
  217. package/src/controller/ControlClasses/OcaGain.js +3 -5
  218. package/src/controller/ControlClasses/OcaGainSensor.d.ts +2 -3
  219. package/src/controller/ControlClasses/OcaGainSensor.js +3 -4
  220. package/src/controller/ControlClasses/OcaGroup.d.ts +140 -0
  221. package/src/controller/ControlClasses/OcaGroup.js +156 -0
  222. package/src/controller/ControlClasses/OcaGrouper.d.ts +20 -140
  223. package/src/controller/ControlClasses/OcaGrouper.js +34 -171
  224. package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +5 -7
  225. package/src/controller/ControlClasses/OcaIdentificationActuator.js +7 -9
  226. package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +5 -6
  227. package/src/controller/ControlClasses/OcaIdentificationSensor.js +6 -7
  228. package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +2 -3
  229. package/src/controller/ControlClasses/OcaImpedanceSensor.js +3 -4
  230. package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +3 -5
  231. package/src/controller/ControlClasses/OcaInt16Actuator.js +4 -6
  232. package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +2 -3
  233. package/src/controller/ControlClasses/OcaInt16Sensor.js +3 -4
  234. package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +3 -5
  235. package/src/controller/ControlClasses/OcaInt32Actuator.js +4 -6
  236. package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +2 -3
  237. package/src/controller/ControlClasses/OcaInt32Sensor.js +3 -4
  238. package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +3 -5
  239. package/src/controller/ControlClasses/OcaInt64Actuator.js +4 -6
  240. package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +2 -3
  241. package/src/controller/ControlClasses/OcaInt64Sensor.js +3 -4
  242. package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +3 -5
  243. package/src/controller/ControlClasses/OcaInt8Actuator.js +4 -6
  244. package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +2 -3
  245. package/src/controller/ControlClasses/OcaInt8Sensor.js +3 -4
  246. package/src/controller/ControlClasses/OcaJsonActuator.d.ts +46 -0
  247. package/src/controller/ControlClasses/OcaJsonActuator.js +58 -0
  248. package/src/controller/ControlClasses/OcaJsonSensor.d.ts +51 -0
  249. package/src/controller/ControlClasses/OcaJsonSensor.js +65 -0
  250. package/src/controller/ControlClasses/OcaLevelSensor.d.ts +1 -2
  251. package/src/controller/ControlClasses/OcaLevelSensor.js +2 -3
  252. package/src/controller/ControlClasses/OcaLibraryManager.d.ts +1 -1
  253. package/src/controller/ControlClasses/OcaLibraryManager.js +3 -3
  254. package/src/controller/ControlClasses/OcaLockManager.d.ts +44 -0
  255. package/src/controller/ControlClasses/OcaLockManager.js +53 -0
  256. package/src/controller/ControlClasses/OcaLog.d.ts +128 -0
  257. package/src/controller/ControlClasses/OcaLog.js +142 -0
  258. package/src/controller/ControlClasses/OcaManager.js +1 -1
  259. package/src/controller/ControlClasses/OcaMatrix.d.ts +104 -82
  260. package/src/controller/ControlClasses/OcaMatrix.js +121 -93
  261. package/src/controller/ControlClasses/OcaMediaClock.d.ts +27 -0
  262. package/src/controller/ControlClasses/OcaMediaClock.js +28 -4
  263. package/src/controller/ControlClasses/OcaMediaClock3.d.ts +16 -22
  264. package/src/controller/ControlClasses/OcaMediaClock3.js +22 -29
  265. package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +7 -10
  266. package/src/controller/ControlClasses/OcaMediaClockManager.js +9 -13
  267. package/src/controller/ControlClasses/OcaMediaRecorderPlayer.d.ts +235 -0
  268. package/src/controller/ControlClasses/OcaMediaRecorderPlayer.js +261 -0
  269. package/src/controller/ControlClasses/OcaMediaTransportApplication.d.ts +612 -0
  270. package/src/controller/ControlClasses/OcaMediaTransportApplication.js +704 -0
  271. package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +12 -25
  272. package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +12 -35
  273. package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.d.ts +235 -0
  274. package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.js +249 -0
  275. package/src/controller/ControlClasses/OcaMute.d.ts +2 -4
  276. package/src/controller/ControlClasses/OcaMute.js +3 -5
  277. package/src/controller/ControlClasses/OcaNetwork.js +1 -1
  278. package/src/controller/ControlClasses/OcaNetworkApplication.d.ts +179 -0
  279. package/src/controller/ControlClasses/OcaNetworkApplication.js +202 -0
  280. package/src/controller/ControlClasses/OcaNetworkInterface.d.ts +318 -0
  281. package/src/controller/ControlClasses/OcaNetworkInterface.js +353 -0
  282. package/src/controller/ControlClasses/OcaNetworkManager.d.ts +45 -17
  283. package/src/controller/ControlClasses/OcaNetworkManager.js +59 -22
  284. package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +1 -1
  285. package/src/controller/ControlClasses/OcaNumericObserver.d.ts +24 -40
  286. package/src/controller/ControlClasses/OcaNumericObserver.js +25 -40
  287. package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +20 -33
  288. package/src/controller/ControlClasses/OcaNumericObserverList.js +26 -39
  289. package/src/controller/ControlClasses/OcaPanBalance.d.ts +4 -8
  290. package/src/controller/ControlClasses/OcaPanBalance.js +5 -9
  291. package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +3 -6
  292. package/src/controller/ControlClasses/OcaPhysicalPosition.js +4 -7
  293. package/src/controller/ControlClasses/OcaPolarity.d.ts +2 -4
  294. package/src/controller/ControlClasses/OcaPolarity.js +3 -5
  295. package/src/controller/ControlClasses/OcaPowerManager.d.ts +30 -14
  296. package/src/controller/ControlClasses/OcaPowerManager.js +32 -17
  297. package/src/controller/ControlClasses/OcaPowerSensor.d.ts +38 -0
  298. package/src/controller/ControlClasses/OcaPowerSensor.js +51 -0
  299. package/src/controller/ControlClasses/OcaPowerSupply.d.ts +8 -16
  300. package/src/controller/ControlClasses/OcaPowerSupply.js +13 -21
  301. package/src/controller/ControlClasses/OcaProgram.d.ts +63 -0
  302. package/src/controller/ControlClasses/OcaProgram.js +82 -0
  303. package/src/controller/ControlClasses/OcaRamper.d.ts +46 -10
  304. package/src/controller/ControlClasses/OcaRamper.js +65 -12
  305. package/src/controller/ControlClasses/OcaRoot.d.ts +69 -24
  306. package/src/controller/ControlClasses/OcaRoot.js +67 -26
  307. package/src/controller/ControlClasses/OcaSamplingRateConverter.d.ts +22 -0
  308. package/src/controller/ControlClasses/OcaSamplingRateConverter.js +28 -0
  309. package/src/controller/ControlClasses/OcaSecurityManager.d.ts +12 -13
  310. package/src/controller/ControlClasses/OcaSecurityManager.js +10 -12
  311. package/src/controller/ControlClasses/OcaSensor.d.ts +1 -2
  312. package/src/controller/ControlClasses/OcaSensor.js +2 -3
  313. package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +21 -39
  314. package/src/controller/ControlClasses/OcaSignalGenerator.js +22 -40
  315. package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -4
  316. package/src/controller/ControlClasses/OcaSignalInput.js +5 -5
  317. package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -4
  318. package/src/controller/ControlClasses/OcaSignalOutput.js +5 -5
  319. package/src/controller/ControlClasses/OcaStateSensor.d.ts +58 -0
  320. package/src/controller/ControlClasses/OcaStateSensor.js +75 -0
  321. package/src/controller/ControlClasses/OcaStreamConnector.js +1 -1
  322. package/src/controller/ControlClasses/OcaStreamNetwork.js +1 -1
  323. package/src/controller/ControlClasses/OcaStringActuator.d.ts +7 -8
  324. package/src/controller/ControlClasses/OcaStringActuator.js +7 -8
  325. package/src/controller/ControlClasses/OcaStringSensor.d.ts +20 -9
  326. package/src/controller/ControlClasses/OcaStringSensor.js +23 -13
  327. package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +211 -41
  328. package/src/controller/ControlClasses/OcaSubscriptionManager.js +224 -39
  329. package/src/controller/ControlClasses/OcaSummingPoint.d.ts +3 -2
  330. package/src/controller/ControlClasses/OcaSummingPoint.js +4 -3
  331. package/src/controller/ControlClasses/OcaSwitch.d.ts +70 -25
  332. package/src/controller/ControlClasses/OcaSwitch.js +113 -35
  333. package/src/controller/ControlClasses/OcaTaskAgent.d.ts +192 -0
  334. package/src/controller/ControlClasses/OcaTaskAgent.js +212 -0
  335. package/src/controller/ControlClasses/OcaTaskManager.d.ts +4 -6
  336. package/src/controller/ControlClasses/OcaTaskManager.js +7 -9
  337. package/src/controller/ControlClasses/OcaTaskScheduler.d.ts +150 -0
  338. package/src/controller/ControlClasses/OcaTaskScheduler.js +159 -0
  339. package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +3 -5
  340. package/src/controller/ControlClasses/OcaTemperatureActuator.js +4 -6
  341. package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +2 -3
  342. package/src/controller/ControlClasses/OcaTemperatureSensor.js +3 -4
  343. package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +1 -2
  344. package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +2 -3
  345. package/src/controller/ControlClasses/OcaTimeSource.d.ts +108 -37
  346. package/src/controller/ControlClasses/OcaTimeSource.js +148 -48
  347. package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +3 -5
  348. package/src/controller/ControlClasses/OcaUint16Actuator.js +4 -6
  349. package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +2 -3
  350. package/src/controller/ControlClasses/OcaUint16Sensor.js +3 -4
  351. package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +3 -5
  352. package/src/controller/ControlClasses/OcaUint32Actuator.js +4 -6
  353. package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +2 -3
  354. package/src/controller/ControlClasses/OcaUint32Sensor.js +3 -4
  355. package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +3 -5
  356. package/src/controller/ControlClasses/OcaUint64Actuator.js +4 -6
  357. package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +2 -3
  358. package/src/controller/ControlClasses/OcaUint64Sensor.js +3 -4
  359. package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +3 -5
  360. package/src/controller/ControlClasses/OcaUint8Actuator.js +4 -6
  361. package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +2 -3
  362. package/src/controller/ControlClasses/OcaUint8Sensor.js +3 -4
  363. package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +2 -3
  364. package/src/controller/ControlClasses/OcaVoltageSensor.js +3 -4
  365. package/src/controller/ControlClasses/OcaWorker.d.ts +84 -37
  366. package/src/controller/ControlClasses/OcaWorker.js +93 -43
  367. package/src/controller/base_event.js +71 -23
  368. package/src/controller/client_connection.d.ts +26 -0
  369. package/src/controller/client_connection.js +39 -7
  370. package/src/controller/event.js +17 -20
  371. package/src/controller/make_control_class.js +3 -1
  372. package/src/controller/notification_error.d.ts +40 -0
  373. package/src/controller/notification_error.js +62 -0
  374. package/src/controller/observeProperty.js +8 -8
  375. package/src/controller/property_event.js +18 -10
  376. package/src/controller/remote_device.js +137 -49
  377. package/src/index.default.d.ts +1 -0
  378. package/src/index.default.js +1 -0
  379. package/src/types/Enum.js +8 -0
  380. package/src/types/OcaActionObjectSearchResult.d.ts +73 -0
  381. package/src/types/OcaActionObjectSearchResult.js +34 -0
  382. package/src/types/OcaActionObjectSearchResultFlags.d.ts +37 -0
  383. package/src/types/OcaActionObjectSearchResultFlags.js +52 -0
  384. package/src/types/OcaApplicationNetworkCommand.d.ts +1 -19
  385. package/src/types/OcaApplicationNetworkCommand.js +0 -24
  386. package/src/types/OcaApplicationNetworkState.d.ts +1 -37
  387. package/src/types/OcaApplicationNetworkState.js +0 -48
  388. package/src/types/OcaBlockConfigurability.d.ts +26 -0
  389. package/src/types/OcaBlockConfigurability.js +35 -0
  390. package/src/types/OcaClassicalFilterShape.d.ts +1 -1
  391. package/src/types/OcaClassicalFilterShape.js +1 -1
  392. package/src/types/OcaCommand.d.ts +44 -0
  393. package/src/types/OcaCommand.js +25 -0
  394. package/src/types/OcaCommandResult.d.ts +42 -0
  395. package/src/types/OcaCommandResult.js +24 -0
  396. package/src/types/OcaCommandSetResult.d.ts +41 -0
  397. package/src/types/OcaCommandSetResult.js +23 -0
  398. package/src/types/OcaConstructionParameter.d.ts +40 -0
  399. package/src/types/OcaConstructionParameter.js +23 -0
  400. package/src/types/OcaCounter.d.ts +81 -0
  401. package/src/types/OcaCounter.js +38 -0
  402. package/src/types/OcaCounterNotifierFilterParameters.d.ts +81 -0
  403. package/src/types/OcaCounterNotifierFilterParameters.js +37 -0
  404. package/src/types/OcaCounterSet.d.ts +38 -0
  405. package/src/types/OcaCounterSet.js +22 -0
  406. package/src/types/OcaCounterUpdate.d.ts +54 -0
  407. package/src/types/OcaCounterUpdate.js +28 -0
  408. package/src/types/OcaCounterUpdateEventData.d.ts +27 -0
  409. package/src/types/OcaCounterUpdateEventData.js +17 -0
  410. package/src/types/OcaDatasetSearchResult.d.ts +51 -0
  411. package/src/types/OcaDatasetSearchResult.js +28 -0
  412. package/src/types/OcaDelayUnit.d.ts +2 -1
  413. package/src/types/OcaDelayUnit.js +2 -1
  414. package/src/types/OcaDelayValue.d.ts +2 -1
  415. package/src/types/OcaDelayValue.js +2 -1
  416. package/src/types/OcaDeviceGenericState.d.ts +62 -0
  417. package/src/types/OcaDeviceGenericState.js +52 -0
  418. package/src/types/OcaDeviceOperationalState.d.ts +42 -0
  419. package/src/types/OcaDeviceOperationalState.js +22 -0
  420. package/src/types/OcaDeviceState.d.ts +2 -2
  421. package/src/types/OcaDeviceState.js +2 -2
  422. package/src/types/OcaExecutableType.d.ts +50 -0
  423. package/src/types/OcaExecutableType.js +36 -0
  424. package/src/types/OcaGenericEndState.d.ts +56 -0
  425. package/src/types/OcaGenericEndState.js +44 -0
  426. package/src/types/OcaGlobalTypeIdentifier.d.ts +12 -12
  427. package/src/types/OcaGlobalTypeIdentifier.js +8 -7
  428. package/src/types/OcaGroupException.d.ts +53 -0
  429. package/src/types/OcaGroupException.js +28 -0
  430. package/src/types/OcaGrouperCitizen.d.ts +10 -10
  431. package/src/types/OcaGrouperCitizen.js +6 -6
  432. package/src/types/OcaGrouperEnrollment.d.ts +4 -9
  433. package/src/types/OcaGrouperEnrollment.js +3 -5
  434. package/src/types/OcaGrouperGroup.d.ts +9 -9
  435. package/src/types/OcaGrouperGroup.js +5 -5
  436. package/src/types/OcaGrouperMode.d.ts +4 -3
  437. package/src/types/OcaGrouperMode.js +4 -3
  438. package/src/types/OcaGrouperStatusChangeEventData.d.ts +2 -2
  439. package/src/types/OcaGrouperStatusChangeEventData.js +2 -2
  440. package/src/types/OcaGrouperStatusChangeType.d.ts +1 -1
  441. package/src/types/OcaGrouperStatusChangeType.js +1 -1
  442. package/src/types/OcaIODirection.d.ts +39 -0
  443. package/src/types/OcaIODirection.js +28 -0
  444. package/src/types/OcaIP4AutoconfigMode.d.ts +56 -0
  445. package/src/types/OcaIP4AutoconfigMode.js +44 -0
  446. package/src/types/OcaIP4Gateway.d.ts +53 -0
  447. package/src/types/OcaIP4Gateway.js +27 -0
  448. package/src/types/OcaIP4NetworkSettings.d.ts +111 -0
  449. package/src/types/OcaIP4NetworkSettings.js +56 -0
  450. package/src/types/OcaIP6AutoconfigMode.d.ts +56 -0
  451. package/src/types/OcaIP6AutoconfigMode.js +44 -0
  452. package/src/types/OcaIP6Gateway.d.ts +53 -0
  453. package/src/types/OcaIP6Gateway.js +27 -0
  454. package/src/types/OcaIP6NetworkSettings.d.ts +123 -0
  455. package/src/types/OcaIP6NetworkSettings.js +61 -0
  456. package/src/types/OcaInterval.d.ts +8 -0
  457. package/src/types/OcaInterval.js +84 -0
  458. package/src/types/OcaIntervalBounds.d.ts +41 -0
  459. package/src/types/OcaIntervalBounds.js +53 -0
  460. package/src/types/OcaJobDisposedEventData.d.ts +57 -0
  461. package/src/types/OcaJobDisposedEventData.js +28 -0
  462. package/src/types/OcaJobDisposition.d.ts +68 -0
  463. package/src/types/OcaJobDisposition.js +60 -0
  464. package/src/types/OcaJobQueueItem.d.ts +105 -0
  465. package/src/types/OcaJobQueueItem.js +44 -0
  466. package/src/types/OcaLibVolType.d.ts +2 -4
  467. package/src/types/OcaLibVolType.js +1 -2
  468. package/src/types/OcaLockState.d.ts +50 -0
  469. package/src/types/OcaLockState.js +36 -0
  470. package/src/types/OcaLogFilter.d.ts +70 -0
  471. package/src/types/OcaLogFilter.js +33 -0
  472. package/src/types/OcaLogRecord.d.ts +85 -0
  473. package/src/types/OcaLogRecord.js +40 -0
  474. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +7 -0
  475. package/src/types/OcaManagerDefaultObjectNumbers.js +7 -0
  476. package/src/types/OcaManagerDescriptor.d.ts +11 -9
  477. package/src/types/OcaManagerDescriptor.js +6 -5
  478. package/src/types/OcaManufacturer.d.ts +87 -0
  479. package/src/types/OcaManufacturer.js +47 -0
  480. package/src/types/OcaMatrixCommand.d.ts +61 -0
  481. package/src/types/OcaMatrixCommand.js +29 -0
  482. package/src/types/OcaMatrixCoordinates.d.ts +38 -0
  483. package/src/types/OcaMatrixCoordinates.js +23 -0
  484. package/src/types/OcaMediaAccessMode.d.ts +50 -0
  485. package/src/types/OcaMediaAccessMode.js +36 -0
  486. package/src/types/OcaMediaClockAvailability.d.ts +1 -1
  487. package/src/types/OcaMediaClockAvailability.js +1 -1
  488. package/src/types/OcaMediaClockRate.d.ts +7 -7
  489. package/src/types/OcaMediaClockRate.js +4 -4
  490. package/src/types/OcaMediaConnection.d.ts +2 -2
  491. package/src/types/OcaMediaConnection.js +1 -1
  492. package/src/types/OcaMediaFrameFormat.d.ts +74 -0
  493. package/src/types/OcaMediaFrameFormat.js +68 -0
  494. package/src/types/OcaMediaPlayOption.d.ts +50 -0
  495. package/src/types/OcaMediaPlayOption.js +36 -0
  496. package/src/types/OcaMediaRecorderPlayerState.d.ts +62 -0
  497. package/src/types/OcaMediaRecorderPlayerState.js +52 -0
  498. package/src/types/OcaMediaStreamCastMode.d.ts +3 -3
  499. package/src/types/OcaMediaStreamCastMode.js +3 -3
  500. package/src/types/OcaMediaStreamEndpoint.d.ts +238 -0
  501. package/src/types/OcaMediaStreamEndpoint.js +114 -0
  502. package/src/types/OcaMediaStreamEndpointCommand.d.ts +80 -0
  503. package/src/types/OcaMediaStreamEndpointCommand.js +76 -0
  504. package/src/types/OcaMediaStreamEndpointState.d.ts +68 -0
  505. package/src/types/OcaMediaStreamEndpointState.js +60 -0
  506. package/src/types/OcaMediaStreamEndpointStatus.d.ts +44 -0
  507. package/src/types/OcaMediaStreamEndpointStatus.js +23 -0
  508. package/src/types/OcaMediaStreamMode.d.ts +83 -0
  509. package/src/types/OcaMediaStreamMode.js +43 -0
  510. package/src/types/OcaMediaStreamModeCapability.d.ts +167 -0
  511. package/src/types/OcaMediaStreamModeCapability.js +81 -0
  512. package/src/types/OcaMediaStreamModeCapabilityDirection.d.ts +21 -0
  513. package/src/types/OcaMediaStreamModeCapabilityDirection.js +27 -0
  514. package/src/types/OcaMediaTrackFunction.d.ts +27 -0
  515. package/src/types/OcaMediaTrackFunction.js +36 -0
  516. package/src/types/OcaMediaTransportSession.d.ts +119 -0
  517. package/src/types/OcaMediaTransportSession.js +58 -0
  518. package/src/types/OcaMediaTransportSessionConnection.d.ts +63 -0
  519. package/src/types/OcaMediaTransportSessionConnection.js +32 -0
  520. package/src/types/OcaMediaTransportSessionConnectionState.d.ts +47 -0
  521. package/src/types/OcaMediaTransportSessionConnectionState.js +24 -0
  522. package/src/types/OcaMediaTransportSessionState.d.ts +62 -0
  523. package/src/types/OcaMediaTransportSessionState.js +52 -0
  524. package/src/types/OcaMediaTransportSessionStatus.d.ts +43 -0
  525. package/src/types/OcaMediaTransportSessionStatus.js +23 -0
  526. package/src/types/OcaMediaTransportTimingParameters.d.ts +54 -0
  527. package/src/types/OcaMediaTransportTimingParameters.js +31 -0
  528. package/src/types/OcaMediaVolumePosition.d.ts +46 -0
  529. package/src/types/OcaMediaVolumePosition.js +23 -0
  530. package/src/types/OcaMediaVolumePositionType.d.ts +44 -0
  531. package/src/types/OcaMediaVolumePositionType.js +28 -0
  532. package/src/types/OcaModelGUID.d.ts +0 -1
  533. package/src/types/OcaModelGUID.js +0 -1
  534. package/src/types/OcaNetworkAdvertisingMechanism.d.ts +43 -0
  535. package/src/types/OcaNetworkAdvertisingMechanism.js +23 -0
  536. package/src/types/OcaNetworkAdvertisingService.d.ts +56 -0
  537. package/src/types/OcaNetworkAdvertisingService.js +44 -0
  538. package/src/types/OcaNetworkInterfaceAssignment.d.ts +99 -0
  539. package/src/types/OcaNetworkInterfaceAssignment.js +51 -0
  540. package/src/types/OcaNetworkInterfaceCommand.d.ts +50 -0
  541. package/src/types/OcaNetworkInterfaceCommand.js +36 -0
  542. package/src/types/OcaNetworkInterfaceState.d.ts +50 -0
  543. package/src/types/OcaNetworkInterfaceState.js +36 -0
  544. package/src/types/OcaNetworkInterfaceStatus.d.ts +42 -0
  545. package/src/types/OcaNetworkInterfaceStatus.js +22 -0
  546. package/src/types/OcaNotificationDeliveryMode.d.ts +13 -1
  547. package/src/types/OcaNotificationDeliveryMode.js +17 -1
  548. package/src/types/OcaOPath.d.ts +16 -2
  549. package/src/types/OcaOPath.js +8 -1
  550. package/src/types/OcaObjectListEventData.d.ts +2 -2
  551. package/src/types/OcaObjectListEventData.js +2 -2
  552. package/src/types/OcaObjectSearchResult.d.ts +4 -83
  553. package/src/types/OcaObjectSearchResult.js +2 -37
  554. package/src/types/OcaObjectSearchResultFlags.d.ts +4 -33
  555. package/src/types/OcaObjectSearchResultFlags.js +2 -48
  556. package/src/types/OcaObservationEventData.d.ts +2 -2
  557. package/src/types/OcaObservationEventData.js +2 -2
  558. package/src/types/OcaObservationListEventData.d.ts +2 -2
  559. package/src/types/OcaObservationListEventData.js +2 -2
  560. package/src/types/OcaObserverState.d.ts +1 -1
  561. package/src/types/OcaObserverState.js +1 -1
  562. package/src/types/OcaParameterMask.d.ts +81 -1
  563. package/src/types/OcaParameterMask.js +131 -1
  564. package/src/types/OcaPort.d.ts +7 -5
  565. package/src/types/OcaPort.js +4 -3
  566. package/src/types/OcaPortClockMapEntry.d.ts +42 -0
  567. package/src/types/OcaPortClockMapEntry.js +23 -0
  568. package/src/types/OcaPortID.d.ts +12 -10
  569. package/src/types/OcaPortID.js +7 -6
  570. package/src/types/OcaPortIdentification.d.ts +39 -0
  571. package/src/types/OcaPortIdentification.js +23 -0
  572. package/src/types/OcaPortMode.d.ts +4 -36
  573. package/src/types/OcaPortMode.js +2 -25
  574. package/src/types/OcaPositionDescriptor.d.ts +6 -6
  575. package/src/types/OcaPositionDescriptor.js +2 -2
  576. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +33 -3
  577. package/src/types/OcaPositionDescriptorFieldFlags.js +53 -3
  578. package/src/types/OcaPowerSupplyState.d.ts +1 -1
  579. package/src/types/OcaPowerSupplyState.js +1 -1
  580. package/src/types/OcaProduct.d.ts +92 -0
  581. package/src/types/OcaProduct.js +42 -0
  582. package/src/types/OcaProgramResult.d.ts +39 -0
  583. package/src/types/OcaProgramResult.js +22 -0
  584. package/src/types/OcaProgramRunMode.d.ts +24 -0
  585. package/src/types/OcaProgramRunMode.js +30 -0
  586. package/src/types/OcaProperty.d.ts +2 -2
  587. package/src/types/OcaProperty.js +2 -2
  588. package/src/types/OcaProtoObjectIdentification.d.ts +1 -1
  589. package/src/types/OcaProtoObjectIdentification.js +1 -1
  590. package/src/types/OcaProtoPort.d.ts +16 -18
  591. package/src/types/OcaProtoPort.js +6 -8
  592. package/src/types/OcaProtoPortClockMapEntry.d.ts +46 -0
  593. package/src/types/OcaProtoPortClockMapEntry.js +25 -0
  594. package/src/types/OcaProtoSignalPath.d.ts +12 -10
  595. package/src/types/OcaProtoSignalPath.js +7 -6
  596. package/src/types/OcaRamperState.d.ts +19 -18
  597. package/src/types/OcaRamperState.js +19 -18
  598. package/src/types/OcaResetCause.d.ts +7 -1
  599. package/src/types/OcaResetCause.js +8 -0
  600. package/src/types/OcaSamplingRateConverterType.d.ts +50 -0
  601. package/src/types/OcaSamplingRateConverterType.js +36 -0
  602. package/src/types/OcaSecurityType.d.ts +39 -0
  603. package/src/types/OcaSecurityType.js +28 -0
  604. package/src/types/OcaSignalPath.d.ts +10 -10
  605. package/src/types/OcaSignalPath.js +6 -6
  606. package/src/types/OcaStatus.d.ts +19 -1
  607. package/src/types/OcaStatus.js +24 -0
  608. package/src/types/OcaStream.d.ts +2 -2
  609. package/src/types/OcaStream.js +1 -1
  610. package/src/types/OcaTask.d.ts +23 -24
  611. package/src/types/OcaTask.js +7 -7
  612. package/src/types/OcaTaskCommand.d.ts +2 -7
  613. package/src/types/OcaTaskCommand.js +2 -9
  614. package/src/types/OcaTaskExecutionTerminatedEventData.d.ts +64 -0
  615. package/src/types/OcaTaskExecutionTerminatedEventData.js +30 -0
  616. package/src/types/OcaTaskGenericState.d.ts +64 -0
  617. package/src/types/OcaTaskGenericState.js +54 -0
  618. package/src/types/OcaTaskManagerState.d.ts +1 -0
  619. package/src/types/OcaTaskManagerState.js +1 -0
  620. package/src/types/OcaTaskOperationalState.d.ts +43 -0
  621. package/src/types/OcaTaskOperationalState.js +22 -0
  622. package/src/types/OcaTaskSchedulerState.d.ts +63 -0
  623. package/src/types/OcaTaskSchedulerState.js +53 -0
  624. package/src/types/OcaTaskStatus.d.ts +2 -12
  625. package/src/types/OcaTaskStatus.js +2 -12
  626. package/src/types/OcaTaskStatusChangedEventData.d.ts +61 -0
  627. package/src/types/OcaTaskStatusChangedEventData.js +29 -0
  628. package/src/types/OcaTime.d.ts +56 -0
  629. package/src/types/OcaTime.js +32 -0
  630. package/src/types/OcaTimeDeliveryMechanism.d.ts +167 -0
  631. package/src/types/OcaTimeDeliveryMechanism.js +191 -0
  632. package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.d.ts +40 -0
  633. package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.js +24 -0
  634. package/src/types/OcaTimePTP.d.ts +4 -51
  635. package/src/types/OcaTimePTP.js +2 -28
  636. package/src/types/OcaTimeReferenceType.d.ts +7 -13
  637. package/src/types/OcaTimeReferenceType.js +6 -14
  638. package/src/types/OcaTimeSourceAvailability.d.ts +1 -1
  639. package/src/types/OcaTimeSourceAvailability.js +1 -1
  640. package/src/types/OcaTimeSourceSyncStatus.d.ts +1 -1
  641. package/src/types/OcaTimeSourceSyncStatus.js +1 -1
  642. package/src/types/OcaTransferFunction.d.ts +1 -1
  643. package/src/types/OcaTransferFunction.js +1 -1
  644. package/src/types/OcaTypedBlob.d.ts +40 -0
  645. package/src/types/OcaTypedBlob.js +24 -0
  646. package/src/types/OcaVariant.d.ts +19 -0
  647. package/src/types/OcaVariant.js +18 -0
  648. package/src/types/OcaWhenPhysicalAbsolute.d.ts +39 -0
  649. package/src/types/OcaWhenPhysicalAbsolute.js +22 -0
  650. package/src/types/OcaWhenPhysicalRelative.d.ts +39 -0
  651. package/src/types/OcaWhenPhysicalRelative.js +22 -0
@@ -1,14 +1,18 @@
1
1
  import { OcaBlob } from '../../OCP1/OcaBlob.js';
2
2
  import { OcaBlobFixedLen } from '../../OCP1/OcaBlobFixedLen.js';
3
3
  import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
4
+ import { OcaDeviceOperationalState } from '../../OCP1/OcaDeviceOperationalState.js';
4
5
  import { OcaDeviceState } from '../../OCP1/OcaDeviceState.js';
5
6
  import { OcaList } from '../../OCP1/OcaList.js';
6
7
  import { OcaManagerDescriptor } from '../../OCP1/OcaManagerDescriptor.js';
8
+ import { OcaManufacturer } from '../../OCP1/OcaManufacturer.js';
7
9
  import { OcaModelDescription } from '../../OCP1/OcaModelDescription.js';
8
10
  import { OcaModelGUID } from '../../OCP1/OcaModelGUID.js';
11
+ import { OcaProduct } from '../../OCP1/OcaProduct.js';
9
12
  import { OcaResetCause } from '../../OCP1/OcaResetCause.js';
10
13
  import { OcaString } from '../../OCP1/OcaString.js';
11
14
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
15
+ import { OcaUint32 } from '../../OCP1/OcaUint32.js';
12
16
  import { make_control_class } from '../make_control_class.js';
13
17
  import { OcaManager } from './OcaManager.js';
14
18
 
@@ -27,7 +31,7 @@ export const OcaDeviceManager = make_control_class(
27
31
  'OcaDeviceManager',
28
32
  3,
29
33
  '\u0001\u0003\u0001',
30
- 2,
34
+ 3,
31
35
  OcaManager,
32
36
  [
33
37
  ['GetOcaVersion', 3, 1, [], [OcaUint16]],
@@ -50,61 +54,77 @@ export const OcaDeviceManager = make_control_class(
50
54
  ['SetMessage', 3, 18, [OcaString], []],
51
55
  ['GetManagers', 3, 19, [], [OcaList(OcaManagerDescriptor)]],
52
56
  ['GetDeviceRevisionID', 3, 20, [], [OcaString]],
57
+ ['GetManufacturer', 3, 21, [], [OcaManufacturer]],
58
+ ['GetProduct', 3, 22, [], [OcaProduct]],
59
+ ['GetOperationalState', 3, 23, [], [OcaDeviceOperationalState]],
60
+ ['GetLoggingEnabled', 3, 24, [], [OcaBoolean]],
61
+ ['SetLoggingEnabled', 3, 25, [OcaBoolean], []],
62
+ ['GetMostRecentPatchDatasetONo', 3, 26, [], [OcaUint32]],
63
+ ['ApplyPatch', 3, 27, [OcaUint32], []],
53
64
  ],
54
65
  [
55
66
  ['ModelGUID', [OcaModelGUID], 3, 1, false, false, null],
56
- ['SerialNumber', [OcaString], 3, 2, false, false, null],
67
+ ['SerialNumber', [OcaString], 3, 2, true, false, null],
57
68
  ['ModelDescription', [OcaModelDescription], 3, 3, false, false, null],
58
69
  ['DeviceName', [OcaString], 3, 4, false, false, null],
59
- ['OcaVersion', [OcaUint16], 3, 5, false, false, null],
60
- ['DeviceRole', [OcaString], 3, 6, false, false, null],
70
+ ['OcaVersion', [OcaUint16], 3, 5, true, false, null],
71
+ ['DeviceRole', [OcaString], 3, 6, false, false, ['Role']],
61
72
  ['UserInventoryCode', [OcaString], 3, 7, false, false, null],
62
- ['Enabled', [OcaBoolean], 3, 8, false, false, null],
73
+ ['ControlEnabled', [OcaBoolean], 3, 8, false, false, ['Enabled']],
63
74
  ['State', [OcaDeviceState], 3, 9, false, false, null],
64
75
  ['Busy', [OcaBoolean], 3, 10, false, false, null],
65
- ['ResetCause', [OcaResetCause], 3, 11, false, false, null],
76
+ ['ResetCause', [OcaResetCause], 3, 11, true, false, null],
66
77
  ['Message', [OcaString], 3, 12, false, false, null],
67
78
  ['Managers', [OcaList(OcaManagerDescriptor)], 3, 13, false, false, null],
68
79
  ['DeviceRevisionID', [OcaString], 3, 14, true, false, null],
80
+ ['Manufacturer', [OcaManufacturer], 3, 15, true, false, null],
81
+ ['Product', [OcaProduct], 3, 16, true, false, null],
82
+ [
83
+ 'OperationalState',
84
+ [OcaDeviceOperationalState],
85
+ 3,
86
+ 17,
87
+ false,
88
+ false,
89
+ null,
90
+ ],
91
+ ['LoggingEnabled', [OcaBoolean], 3, 18, false, false, null],
92
+ ['MostRecentPatchDatasetONo', [OcaUint32], 3, 19, false, false, null],
69
93
  ],
70
94
  []
71
95
  );
72
96
 
73
97
  /**
74
- * Gets the value of the OcaVersion property. The return value indicates whether
75
- * the property was successfully retrieved.
98
+ * Gets the value of the **OcaVersion** property.
76
99
  *
77
100
  * @method OcaDeviceManager#GetOcaVersion
78
101
  * @returns {Promise<number>}
79
102
  * A promise which resolves to a single value of type ``number``.
80
103
  */
81
104
  /**
82
- * Gets the model GUID. The return value indicates whether the GUID was
83
- * successfully retrieved.
105
+ * Gets the model GUID. **Deprecated** in v3 of this class, replaced by
106
+ * **GetProduct()** .
84
107
  *
85
108
  * @method OcaDeviceManager#GetModelGUID
86
109
  * @returns {Promise<OcaModelGUID>}
87
110
  * A promise which resolves to a single value of type :class:`OcaModelGUID`.
88
111
  */
89
112
  /**
90
- * Gets the value of the SerialNumber property. The return value indicates
91
- * whether the property was successfully retrieved.
113
+ * Gets the value of the **SerialNumber** property.
92
114
  *
93
115
  * @method OcaDeviceManager#GetSerialNumber
94
116
  * @returns {Promise<string>}
95
117
  * A promise which resolves to a single value of type ``string``.
96
118
  */
97
119
  /**
98
- * Gets the device name. The return value indicates whether the property was
99
- * successfully retrieved.
120
+ * Gets the device name.
100
121
  *
101
122
  * @method OcaDeviceManager#GetDeviceName
102
123
  * @returns {Promise<string>}
103
124
  * A promise which resolves to a single value of type ``string``.
104
125
  */
105
126
  /**
106
- * Sets the device name. The return value indicates whether the property was
107
- * successfully set.
127
+ * Sets the device name.
108
128
  *
109
129
  * @method OcaDeviceManager#SetDeviceName
110
130
  * @param {string} Name
@@ -112,24 +132,22 @@ export const OcaDeviceManager = make_control_class(
112
132
  * @returns {Promise<void>}
113
133
  */
114
134
  /**
115
- * Gets the model description. The return value indicates whether the
116
- * description was successfully retrieved.
135
+ * Gets the model description. **Deprecated** in v3 of this class, replaced by**
136
+ * GetProduct()** .
117
137
  *
118
138
  * @method OcaDeviceManager#GetModelDescription
119
139
  * @returns {Promise<OcaModelDescription>}
120
140
  * A promise which resolves to a single value of type :class:`OcaModelDescription`.
121
141
  */
122
142
  /**
123
- * Gets the value of the Role property. The return value indicates whether the
124
- * property was successfully retrieved.
143
+ * Gets the value of the **DeviceRole** property.
125
144
  *
126
145
  * @method OcaDeviceManager#GetDeviceRole
127
146
  * @returns {Promise<string>}
128
147
  * A promise which resolves to a single value of type ``string``.
129
148
  */
130
149
  /**
131
- * Sets the value of the Role property. The return value indicates whether the
132
- * property was successfully set.
150
+ * Sets the value of the **DeviceRole** property.
133
151
  *
134
152
  * @method OcaDeviceManager#SetDeviceRole
135
153
  * @param {string} role
@@ -137,16 +155,14 @@ export const OcaDeviceManager = make_control_class(
137
155
  * @returns {Promise<void>}
138
156
  */
139
157
  /**
140
- * Gets the value of the UserInventoryCode property. The return value indicates
141
- * whether the property was successfully retrieved.
158
+ * Gets the value of the **UserInventoryCode** property.
142
159
  *
143
160
  * @method OcaDeviceManager#GetUserInventoryCode
144
161
  * @returns {Promise<string>}
145
162
  * A promise which resolves to a single value of type ``string``.
146
163
  */
147
164
  /**
148
- * Sets the value of the UserInventoryCode property. The return value indicates
149
- * whether the property was successfully set.
165
+ * Sets the value of the **UserInventoryCode** property.
150
166
  *
151
167
  * @method OcaDeviceManager#SetUserInventoryCode
152
168
  * @param {string} Code
@@ -154,16 +170,14 @@ export const OcaDeviceManager = make_control_class(
154
170
  * @returns {Promise<void>}
155
171
  */
156
172
  /**
157
- * Gets the value of the Enabled property. The return value indicates whether
158
- * the property was successfully retrieved.
173
+ * Gets the value of the **Enabled** property. Deprecated in v3 of this class.
159
174
  *
160
175
  * @method OcaDeviceManager#GetEnabled
161
176
  * @returns {Promise<boolean>}
162
177
  * A promise which resolves to a single value of type ``boolean``.
163
178
  */
164
179
  /**
165
- * Sets the value of the Enabled property. The return value indicates whether
166
- * the property was successfully set.
180
+ * Sets the value of the **Enabled** property. Deprecated in v3 of this class.
167
181
  *
168
182
  * @method OcaDeviceManager#SetEnabled
169
183
  * @param {boolean} enabled
@@ -171,18 +185,16 @@ export const OcaDeviceManager = make_control_class(
171
185
  * @returns {Promise<void>}
172
186
  */
173
187
  /**
174
- * Gets the value of the State property. The return value indicates whether the
175
- * property was successfully retrieved.
188
+ * Gets the value of the State property. **Deprecated** in v3 of this class,
189
+ * replaced by **.GetOperationalState() .**
176
190
  *
177
191
  * @method OcaDeviceManager#GetState
178
192
  * @returns {Promise<IOcaDeviceState>}
179
193
  * A promise which resolves to a single value of type ``IOcaDeviceState``.
180
194
  */
181
195
  /**
182
- * Sets the value of the reset key of the device. The return value indicates
183
- * whether the property was successfully set. Note that the device manager must
184
- * inform the CAP gateway of this key (via the host interface), since the CAP
185
- * gateway will check for and handle the special reset message.
196
+ * Sets the value of the reset key and the required source address for the reset
197
+ * command. If given address is null, all source addresses will be accepted.
186
198
  *
187
199
  * @method OcaDeviceManager#SetResetKey
188
200
  * @param {Uint8Array} Key
@@ -191,36 +203,32 @@ export const OcaDeviceManager = make_control_class(
191
203
  * @returns {Promise<void>}
192
204
  */
193
205
  /**
194
- * Gets the value of the ResetCause property. The return value indicates whether
195
- * the property was successfully retrieved.
206
+ * Gets the value of the **ResetCause** property.
196
207
  *
197
208
  * @method OcaDeviceManager#GetResetCause
198
209
  * @returns {Promise<OcaResetCause>}
199
210
  * A promise which resolves to a single value of type :class:`OcaResetCause`.
200
211
  */
201
212
  /**
202
- * Clears the ResetCause property, i.e. resets it to the default value
213
+ * Clears the **ResetCause** property, i.e. resets it to the default value
203
214
  * 'PowerOn'. Must be used after the reset cause has been read out to ensure
204
- * differentation between reconnects due to network loss and reconnects due to
215
+ * differentiation between reconnects due to network loss and reconnects due to
205
216
  * external or internal reset. Offered as a separate method (instead of
206
- * implicitly clearing the cause after it has been read out) to accomodate
207
- * systems that have multiple controllers. The return value indicates whether
208
- * the property was successfully retrieved.
217
+ * implicitly clearing the cause after it has been read out) to accommodate
218
+ * systems that have multiple controllers.
209
219
  *
210
220
  * @method OcaDeviceManager#ClearResetCause
211
221
  * @returns {Promise<void>}
212
222
  */
213
223
  /**
214
- * Gets the value of property **Message**. Return value indicates whether value
215
- * was successfully retrieved.
224
+ * Gets the value of property **Message**.
216
225
  *
217
226
  * @method OcaDeviceManager#GetMessage
218
227
  * @returns {Promise<string>}
219
228
  * A promise which resolves to a single value of type ``string``.
220
229
  */
221
230
  /**
222
- * Set arbitrary text message into **Message** property. The return value
223
- * indicates whether the value was successfully set.
231
+ * Set arbitrary text message into **Message** property.
224
232
  *
225
233
  * @method OcaDeviceManager#SetMessage
226
234
  * @param {string} Text
@@ -228,21 +236,72 @@ export const OcaDeviceManager = make_control_class(
228
236
  * @returns {Promise<void>}
229
237
  */
230
238
  /**
231
- * Retrive the list of descriptors of managers instantiated in this device. The
232
- * return value indicates whether the retrieval was successful.
239
+ * Retrive the list of descriptors of managers instantiated in this device.
233
240
  *
234
241
  * @method OcaDeviceManager#GetManagers
235
242
  * @returns {Promise<OcaManagerDescriptor[]>}
236
243
  * A promise which resolves to a single value of type :class:`OcaManagerDescriptor[]`.
237
244
  */
238
245
  /**
239
- * Gets the value of property **DeviceRevisionID**. Return value indicates
240
- * whether value was successfully retrieved.
246
+ * Gets the value of deprecated property **DeviceRevisionID**. **Deprecated** in
247
+ * v3 of this class, replaced by **.GetProduct()** .
241
248
  *
242
249
  * @method OcaDeviceManager#GetDeviceRevisionID
243
250
  * @returns {Promise<string>}
244
251
  * A promise which resolves to a single value of type ``string``.
245
252
  */
253
+ /**
254
+ * Gets the device's manufacturer descriptor.
255
+ *
256
+ * @method OcaDeviceManager#GetManufacturer
257
+ * @returns {Promise<OcaManufacturer>}
258
+ * A promise which resolves to a single value of type :class:`OcaManufacturer`.
259
+ */
260
+ /**
261
+ * Gets the device's product descriptor.
262
+ *
263
+ * @method OcaDeviceManager#GetProduct
264
+ * @returns {Promise<OcaProduct>}
265
+ * A promise which resolves to a single value of type :class:`OcaProduct`.
266
+ */
267
+ /**
268
+ * Gets the device's operational state.
269
+ *
270
+ * @method OcaDeviceManager#GetOperationalState
271
+ * @returns {Promise<OcaDeviceOperationalState>}
272
+ * A promise which resolves to a single value of type :class:`OcaDeviceOperationalState`.
273
+ */
274
+ /**
275
+ * Gets the value of property **LoggingEnabled**.
276
+ *
277
+ * @method OcaDeviceManager#GetLoggingEnabled
278
+ * @returns {Promise<boolean>}
279
+ * A promise which resolves to a single value of type ``boolean``.
280
+ */
281
+ /**
282
+ * Sets the value of property **LoggingEnabled**.
283
+ *
284
+ * @method OcaDeviceManager#SetLoggingEnabled
285
+ * @param {boolean} Enabled
286
+ *
287
+ * @returns {Promise<void>}
288
+ */
289
+ /**
290
+ * Gets the value of property **MostRecentPatchDatasetONo**.
291
+ *
292
+ * @method OcaDeviceManager#GetMostRecentPatchDatasetONo
293
+ * @returns {Promise<number>}
294
+ * A promise which resolves to a single value of type ``number``.
295
+ */
296
+ /**
297
+ * Applies the patch in the **OcaDataset** identified by the given **ONo**, and
298
+ * sets the value of property MostRecentPatchDatasetONo.
299
+ *
300
+ * @method OcaDeviceManager#ApplyPatch
301
+ * @param {number} ONo
302
+ *
303
+ * @returns {Promise<void>}
304
+ */
246
305
  /**
247
306
  * This event is emitted when the property ``ModelGUID`` changes in the remote object.
248
307
  * The property ``ModelGUID`` is described in the AES70 standard as follows.
@@ -250,46 +309,40 @@ export const OcaDeviceManager = make_control_class(
250
309
  * property is not equivalent to a MAC address, because (a) MAC addresses
251
310
  * identify individual devices, not models, and (b) MAC addresses are
252
311
  * Ethernet-specific, but an OCA device need not have an Ethernet port.
312
+ * **Deprecated** in v3 of this class, moved into property **Product** .
253
313
  *
254
314
  * @member {PropertyEvent<OcaModelGUID>} OcaDeviceManager#OnModelGUIDChanged
255
315
  */
256
- /**
257
- * This event is emitted when the property ``SerialNumber`` changes in the remote object.
258
- * The property ``SerialNumber`` is described in the AES70 standard as follows.
259
- * Read-only property that identifies the serial number of the CAP device.
260
- *
261
- * @member {PropertyEvent<string>} OcaDeviceManager#OnSerialNumberChanged
262
- */
263
316
  /**
264
317
  * This event is emitted when the property ``ModelDescription`` changes in the remote object.
265
318
  * The property ``ModelDescription`` is described in the AES70 standard as follows.
266
319
  * Read-only property that contains text names for this model, its manufacturer,
267
- * and its version.
320
+ * and its version. **Deprecated** in v3 of this class, moved into property
321
+ * **Product**.
268
322
  *
269
323
  * @member {PropertyEvent<OcaModelDescription>} OcaDeviceManager#OnModelDescriptionChanged
270
324
  */
271
325
  /**
272
326
  * This event is emitted when the property ``DeviceName`` changes in the remote object.
273
327
  * The property ``DeviceName`` is described in the AES70 standard as follows.
274
- * Name of the device. Should be unique manufacturer-qualified identifier.
328
+ * User-specified name of this device in application context. Device instance
329
+ * name, not product name.
275
330
  *
276
331
  * @member {PropertyEvent<string>} OcaDeviceManager#OnDeviceNameChanged
277
332
  */
278
- /**
279
- * This event is emitted when the property ``OcaVersion`` changes in the remote object.
280
- * The property ``OcaVersion`` is described in the AES70 standard as follows.
281
- * Read-only property that indicates the AES70 version number used by the
282
- * device.
283
- *
284
- * @member {PropertyEvent<number>} OcaDeviceManager#OnOcaVersionChanged
285
- */
286
333
  /**
287
334
  * This event is emitted when the property ``DeviceRole`` changes in the remote object.
288
335
  * The property ``DeviceRole`` is described in the AES70 standard as follows.
289
- * Role of device in application (arbitrary).
336
+ * Role of device in application (arbitrary). Named **Role** prior to v3 of this
337
+ * class.
290
338
  *
291
339
  * @member {PropertyEvent<string>} OcaDeviceManager#OnDeviceRoleChanged
292
340
  */
341
+ /**
342
+ * An alias for OnDeviceRoleChanged
343
+ *
344
+ * @member {PropertyEvent<string>} OcaDeviceManager#OnRoleChanged
345
+ */
293
346
  /**
294
347
  * This event is emitted when the property ``UserInventoryCode`` changes in the remote object.
295
348
  * The property ``UserInventoryCode`` is described in the AES70 standard as follows.
@@ -298,34 +351,34 @@ export const OcaDeviceManager = make_control_class(
298
351
  * @member {PropertyEvent<string>} OcaDeviceManager#OnUserInventoryCodeChanged
299
352
  */
300
353
  /**
301
- * This event is emitted when the property ``Enabled`` changes in the remote object.
302
- * The property ``Enabled`` is described in the AES70 standard as follows.
303
- * Indicates whether the device is enabled (and therefore operational).
354
+ * This event is emitted when the property ``ControlEnabled`` changes in the remote object.
355
+ * The property ``ControlEnabled`` is described in the AES70 standard as follows.
356
+ * Indicates whether the device is enabled, i.e. whether it is responsive to OCA
357
+ * commands. Prior to v3 of this class, property name was **Enabled**.
358
+ *
359
+ * @member {PropertyEvent<boolean>} OcaDeviceManager#OnControlEnabledChanged
360
+ */
361
+ /**
362
+ * An alias for OnControlEnabledChanged
304
363
  *
305
364
  * @member {PropertyEvent<boolean>} OcaDeviceManager#OnEnabledChanged
306
365
  */
307
366
  /**
308
367
  * This event is emitted when the property ``State`` changes in the remote object.
309
368
  * The property ``State`` is described in the AES70 standard as follows.
310
- * Read-only property that indicates the current state of the device.
369
+ * Read-only property that indicates the current state of the device. Deprecated
370
+ * in v3 of this class, replaced by **.OperationalState** .
311
371
  *
312
372
  * @member {PropertyEvent<IOcaDeviceState>} OcaDeviceManager#OnStateChanged
313
373
  */
314
374
  /**
315
375
  * This event is emitted when the property ``Busy`` changes in the remote object.
316
376
  * The property ``Busy`` is described in the AES70 standard as follows.
317
- * True iff device is working on something and is not available for OCA command
318
- * activity. Readonly.
377
+ * True if and only if device is working on something and is not available for
378
+ * OCA command activity. Readonly. **Deprecated** in v3 of this class.
319
379
  *
320
380
  * @member {PropertyEvent<boolean>} OcaDeviceManager#OnBusyChanged
321
381
  */
322
- /**
323
- * This event is emitted when the property ``ResetCause`` changes in the remote object.
324
- * The property ``ResetCause`` is described in the AES70 standard as follows.
325
- * Read-only attribute that indicates the reset cause of the last reset.
326
- *
327
- * @member {PropertyEvent<OcaResetCause>} OcaDeviceManager#OnResetCauseChanged
328
- */
329
382
  /**
330
383
  * This event is emitted when the property ``Message`` changes in the remote object.
331
384
  * The property ``Message`` is described in the AES70 standard as follows.
@@ -337,7 +390,32 @@ export const OcaDeviceManager = make_control_class(
337
390
  /**
338
391
  * This event is emitted when the property ``Managers`` changes in the remote object.
339
392
  * The property ``Managers`` is described in the AES70 standard as follows.
340
- * List of all manager objects instantiated in this device.
393
+ * List of all manager objects (including the Device Manager) instantiated in
394
+ * this device.
341
395
  *
342
396
  * @member {PropertyEvent<OcaManagerDescriptor[]>} OcaDeviceManager#OnManagersChanged
343
397
  */
398
+ /**
399
+ * This event is emitted when the property ``OperationalState`` changes in the remote object.
400
+ * The property ``OperationalState`` is described in the AES70 standard as follows.
401
+ * Operational state of device.
402
+ *
403
+ * @member {PropertyEvent<OcaDeviceOperationalState>} OcaDeviceManager#OnOperationalStateChanged
404
+ */
405
+ /**
406
+ * This event is emitted when the property ``LoggingEnabled`` changes in the remote object.
407
+ * The property ``LoggingEnabled`` is described in the AES70 standard as follows.
408
+ * Global enable/disable switch for device logging. TRUE = logging enabled,
409
+ * FALSE = logging disabled. See class **OcaLog** for the rest of the logging
410
+ * mechanism.
411
+ *
412
+ * @member {PropertyEvent<boolean>} OcaDeviceManager#OnLoggingEnabledChanged
413
+ */
414
+ /**
415
+ * This event is emitted when the property ``MostRecentPatchDatasetONo`` changes in the remote object.
416
+ * The property ``MostRecentPatchDatasetONo`` is described in the AES70 standard as follows.
417
+ * **ONo** of **OcaDataset** containing the most recently applied patch. Zero if
418
+ * no patch has been applied since last device reset.
419
+ *
420
+ * @member {PropertyEvent<number>} OcaDeviceManager#OnMostRecentPatchDatasetONoChanged
421
+ */
@@ -1,4 +1,4 @@
1
- import { IOcaTimePTP, OcaTimePTP } from '../../types/OcaTimePTP';
1
+ import { IOcaTime, OcaTime } from '../../types/OcaTime';
2
2
  import { PropertyEvent } from '../property_event';
3
3
  import { RemoteDevice } from '../remote_device';
4
4
  import { OcaManager } from './OcaManager';
@@ -7,10 +7,12 @@ import { OcaManager } from './OcaManager';
7
7
  * Manager that allows controlling and monitoring a device's time-of-day clock,
8
8
  * and that collects the device's time source objects.
9
9
  *
10
- * - Must be instantiated once in every device that has more than one time
11
- * source object. In this context, a "time source object" is an instance of
10
+ * - Must be instantiated in every device that has more than one time source
11
+ * object. In this context, a "time source object" is an instance of
12
12
  * **OcaTimeSource** or a subclass of it.
13
13
  *
14
+ * - May be instantiated at most once in any device.
15
+ *
14
16
  * - If instantiated, object number must be 10.
15
17
  *
16
18
  *
@@ -37,9 +39,8 @@ export declare class OcaDeviceTimeManager extends OcaManager {
37
39
  constructor(objectNumber: number, device: RemoteDevice);
38
40
 
39
41
  /**
40
- * Get current value of device time-of-day clock in NTP format. Return value
41
- * indicates whether value was successfully retrieved. This method is optional
42
- * and deprecated.
42
+ * Get current value of device time-of-day clock in NTP format. **Deprecated**
43
+ * in version 3 of this class.
43
44
  *
44
45
  * @method OcaDeviceTimeManager#GetDeviceTimeNTP
45
46
  * @returns {Promise<number|BigInt>}
@@ -48,9 +49,9 @@ export declare class OcaDeviceTimeManager extends OcaManager {
48
49
  GetDeviceTimeNTP(): Promise<number | BigInt>;
49
50
 
50
51
  /**
51
- * Sets device time-of-day clock in NTP format. Return value indicates whether
52
- * value was successfully set. Not available if a time source is identified in
53
- * property CurrentDeviceTimeSource. This method is optional and deprecated.
52
+ * Sets device time-of-day clock in NTP format. Not available if a time source
53
+ * is identified in property CurrentDeviceTimeSource. **Deprecated** in
54
+ * version 3 of this class.
54
55
  *
55
56
  * @method OcaDeviceTimeManager#SetDeviceTimeNTP
56
57
  * @param {number|BigInt} DeviceTime
@@ -60,8 +61,7 @@ export declare class OcaDeviceTimeManager extends OcaManager {
60
61
  SetDeviceTimeNTP(DeviceTime: number | BigInt): Promise<void>;
61
62
 
62
63
  /**
63
- * Returns list of object numbers of OcaTimeSource instances in this device.
64
- * Return value indicates whether list was successfully retrieved.
64
+ * Gets the list of object numbers of OcaTimeSource instances in this device.
65
65
  *
66
66
  * @method OcaDeviceTimeManager#GetTimeSources
67
67
  * @returns {Promise<number[]>}
@@ -70,8 +70,7 @@ export declare class OcaDeviceTimeManager extends OcaManager {
70
70
  GetTimeSources(): Promise<number[]>;
71
71
 
72
72
  /**
73
- * Retrieves ONo of current time source object, or zero if none. Return value
74
- * indicates whether value was successfully retrieved.
73
+ * Retrieves **ONo** of current time source object, or zero if none.
75
74
  *
76
75
  * @method OcaDeviceTimeManager#GetCurrentDeviceTimeSource
77
76
  * @returns {Promise<number>}
@@ -80,8 +79,7 @@ export declare class OcaDeviceTimeManager extends OcaManager {
80
79
  GetCurrentDeviceTimeSource(): Promise<number>;
81
80
 
82
81
  /**
83
- * Sets ONo of current time source object, or zero if none. Return value
84
- * indicates whether value was successfully retrieved.
82
+ * Sets **ONo** of current time source object, or zero if none.
85
83
  *
86
84
  * @method OcaDeviceTimeManager#SetCurrentDeviceTimeSource
87
85
  * @param {number} TimeSourceONo
@@ -91,24 +89,44 @@ export declare class OcaDeviceTimeManager extends OcaManager {
91
89
  SetCurrentDeviceTimeSource(TimeSourceONo: number): Promise<void>;
92
90
 
93
91
  /**
94
- * Get current value of device time-of-day clock in PTP format. Return value
95
- * indicates whether value was successfully retrieved.
92
+ * Get current value of device time-of-day clock.
93
+ *
94
+ * @method OcaDeviceTimeManager#GetDeviceTime
95
+ * @returns {Promise<OcaTime>}
96
+ * A promise which resolves to a single value of type :class:`OcaTime`.
97
+ */
98
+ GetDeviceTime(): Promise<OcaTime>;
99
+
100
+ /**
101
+ * Get current value of device time-of-day clock.
102
+ * An alias for GetDeviceTime.
96
103
  *
97
104
  * @method OcaDeviceTimeManager#GetDeviceTimePTP
98
- * @returns {Promise<OcaTimePTP>}
99
- * A promise which resolves to a single value of type :class:`OcaTimePTP`.
105
+ * @returns {Promise<OcaTime>}
106
+ * A promise which resolves to a single value of type :class:`OcaTime`.
107
+ */
108
+ GetDeviceTimePTP(): Promise<OcaTime>;
109
+
110
+ /**
111
+ * Sets device time-of-day clock Not available if a time source is identified
112
+ * in property **CurrentDeviceTimeSource**.
113
+ *
114
+ * @method OcaDeviceTimeManager#SetDeviceTime
115
+ * @param {IOcaTime} DeviceTime
116
+ *
117
+ * @returns {Promise<void>}
100
118
  */
101
- GetDeviceTimePTP(): Promise<OcaTimePTP>;
119
+ SetDeviceTime(DeviceTime: IOcaTime): Promise<void>;
102
120
 
103
121
  /**
104
- * Sets device time-of-day clock in PTP format. Return value indicates whether
105
- * value was successfully set. Not available if a time source is identified in
106
- * property CurrentDeviceTimeSource.
122
+ * Sets device time-of-day clock Not available if a time source is identified
123
+ * in property **CurrentDeviceTimeSource**.
124
+ * An alias for SetDeviceTime.
107
125
  *
108
126
  * @method OcaDeviceTimeManager#SetDeviceTimePTP
109
- * @param {IOcaTimePTP} DeviceTime
127
+ * @param {IOcaTime} DeviceTime
110
128
  *
111
129
  * @returns {Promise<void>}
112
130
  */
113
- SetDeviceTimePTP(DeviceTime: IOcaTimePTP): Promise<void>;
131
+ SetDeviceTimePTP(DeviceTime: IOcaTime): Promise<void>;
114
132
  }