mx-remote 11.0.0__tar.gz → 12.0.0__tar.gz

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 (286) hide show
  1. {mx_remote-11.0.0 → mx_remote-12.0.0}/PKG-INFO +1 -1
  2. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/api.md +23 -2
  3. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/oneip.md +44 -15
  4. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/Interface.py +61 -12
  5. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/Interface.pyi +23 -4
  6. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/const.py +1 -1
  7. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Constants.py +26 -7
  8. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Constants.pyi +7 -1
  9. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameHello.py +4 -2
  10. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCSettings.py +22 -4
  11. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCSettings.pyi +3 -1
  12. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.py +28 -23
  13. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.pyi +3 -3
  14. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPTiling.py +11 -9
  15. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Device.py +83 -30
  16. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Device.pyi +8 -5
  17. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Remote.py +7 -4
  18. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/controllerset.py +37 -34
  19. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/meshcontrol.py +10 -0
  20. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/preview.py +11 -9
  21. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/rcsettings.py +71 -0
  22. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/unit.py +7 -0
  23. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/wirefix.py +14 -0
  24. {mx_remote-11.0.0 → mx_remote-12.0.0}/.gitignore +0 -0
  25. {mx_remote-11.0.0 → mx_remote-12.0.0}/AGENTS.md +0 -0
  26. {mx_remote-11.0.0 → mx_remote-12.0.0}/CLAUDE.md +0 -0
  27. {mx_remote-11.0.0 → mx_remote-12.0.0}/LICENSE +0 -0
  28. {mx_remote-11.0.0 → mx_remote-12.0.0}/README.md +0 -0
  29. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/README.md +0 -0
  30. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/_static/brand.css +0 -0
  31. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/_static/favicon.svg +0 -0
  32. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/_static/logo-dark.svg +0 -0
  33. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/_static/logo.svg +0 -0
  34. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/audio.md +0 -0
  35. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/callbacks.md +0 -0
  36. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/conf.py +0 -0
  37. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/configuration.md +0 -0
  38. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/devices-and-bays.md +0 -0
  39. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/diagnostics.md +0 -0
  40. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/index.md +0 -0
  41. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/multiviewer.md +0 -0
  42. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/requirements.txt +0 -0
  43. {mx_remote-11.0.0 → mx_remote-12.0.0}/docs/routing.md +0 -0
  44. {mx_remote-11.0.0 → mx_remote-12.0.0}/hatch_build.py +0 -0
  45. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/Uid.py +0 -0
  46. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/Uid.pyi +0 -0
  47. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/__init__.py +0 -0
  48. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/__init__.pyi +0 -0
  49. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/compat.py +0 -0
  50. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/compat.pyi +0 -0
  51. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/const.pyi +0 -0
  52. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/deprecated.py +0 -0
  53. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/deprecated.pyi +0 -0
  54. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/main.py +0 -0
  55. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/main.pyi +0 -0
  56. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/BayConfig.py +0 -0
  57. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/BayConfig.pyi +0 -0
  58. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Data.py +0 -0
  59. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Data.pyi +0 -0
  60. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Factory.py +0 -0
  61. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Factory.pyi +0 -0
  62. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAmpDolbySettings.py +0 -0
  63. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAmpDolbySettings.pyi +0 -0
  64. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAmpZoneSettings.py +0 -0
  65. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAmpZoneSettings.pyi +0 -0
  66. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAudioClip.py +0 -0
  67. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAudioClip.pyi +0 -0
  68. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAudioSetRoute.py +0 -0
  69. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameAudioSetRoute.pyi +0 -0
  70. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBase.py +0 -0
  71. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBase.pyi +0 -0
  72. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayConfig.py +0 -0
  73. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayConfig.pyi +0 -0
  74. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayConfigSecondary.py +0 -0
  75. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayConfigSecondary.pyi +0 -0
  76. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayContent.py +0 -0
  77. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayContent.pyi +0 -0
  78. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayHide.py +0 -0
  79. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayHide.pyi +0 -0
  80. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayStatus.py +0 -0
  81. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameBayStatus.pyi +0 -0
  82. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameConnectStatus.py +0 -0
  83. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameConnectStatus.pyi +0 -0
  84. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameDebug.py +0 -0
  85. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameDebug.pyi +0 -0
  86. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameDiscover.py +0 -0
  87. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameDiscover.pyi +0 -0
  88. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameEDID.py +0 -0
  89. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameEDID.pyi +0 -0
  90. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameEDIDProfile.py +0 -0
  91. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameEDIDProfile.pyi +0 -0
  92. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFactoryReset.py +0 -0
  93. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFactoryReset.pyi +0 -0
  94. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFilterStatus.py +0 -0
  95. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFilterStatus.pyi +0 -0
  96. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFirmwareVersion.py +0 -0
  97. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameFirmwareVersion.pyi +0 -0
  98. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameHeader.py +0 -0
  99. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameHeader.pyi +0 -0
  100. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameHello.pyi +0 -0
  101. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameLinks.py +0 -0
  102. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameLinks.pyi +0 -0
  103. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMeshOperation.py +0 -0
  104. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMeshOperation.pyi +0 -0
  105. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMirrorStatus.py +0 -0
  106. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMirrorStatus.pyi +0 -0
  107. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMonitoringPulse.py +0 -0
  108. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameMonitoringPulse.pyi +0 -0
  109. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameNetworkStatus.py +0 -0
  110. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameNetworkStatus.pyi +0 -0
  111. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FramePing.py +0 -0
  112. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FramePing.pyi +0 -0
  113. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FramePowerChange.py +0 -0
  114. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FramePowerChange.pyi +0 -0
  115. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCAction.py +0 -0
  116. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCAction.pyi +0 -0
  117. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCIr.py +0 -0
  118. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCIr.pyi +0 -0
  119. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCKey.py +0 -0
  120. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRCKey.pyi +0 -0
  121. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameReboot.py +0 -0
  122. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameReboot.pyi +0 -0
  123. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRoutingChange.py +0 -0
  124. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameRoutingChange.pyi +0 -0
  125. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetInstaller.py +0 -0
  126. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetInstaller.pyi +0 -0
  127. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetName.py +0 -0
  128. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetName.pyi +0 -0
  129. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetRoute.py +0 -0
  130. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetRoute.pyi +0 -0
  131. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetupStatus.py +0 -0
  132. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSetupStatus.pyi +0 -0
  133. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSignalStatus.py +0 -0
  134. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSignalStatus.pyi +0 -0
  135. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSignalStatusNew.py +0 -0
  136. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSignalStatusNew.pyi +0 -0
  137. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSysTemperature.py +0 -0
  138. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSysTemperature.pyi +0 -0
  139. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSystemStatus.py +0 -0
  140. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameSystemStatus.pyi +0 -0
  141. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTXRCAction.py +0 -0
  142. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTXRCAction.pyi +0 -0
  143. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTXRCKey.py +0 -0
  144. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTXRCKey.pyi +0 -0
  145. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameThirdParty.py +0 -0
  146. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameThirdParty.pyi +0 -0
  147. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTime.py +0 -0
  148. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTime.pyi +0 -0
  149. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTimeZone.py +0 -0
  150. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTimeZone.pyi +0 -0
  151. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTopology.py +0 -0
  152. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTopology.pyi +0 -0
  153. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTxIR.py +0 -0
  154. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameTxIR.pyi +0 -0
  155. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUnitCommand.py +0 -0
  156. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUnitCommand.pyi +0 -0
  157. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUnitStatus.py +0 -0
  158. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUnitStatus.pyi +0 -0
  159. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUpgradeFPGA.py +0 -0
  160. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameUpgradeFPGA.pyi +0 -0
  161. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPAudio.py +0 -0
  162. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPAudio.pyi +0 -0
  163. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPBayMapping.py +0 -0
  164. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPBayMapping.pyi +0 -0
  165. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPDetectBays.py +0 -0
  166. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPDetectBays.pyi +0 -0
  167. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPLink.py +0 -0
  168. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPLink.pyi +0 -0
  169. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPManualSourceSwitch.py +0 -0
  170. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPManualSourceSwitch.pyi +0 -0
  171. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPMultiviewer.py +0 -0
  172. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPMultiviewer.pyi +0 -0
  173. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPOsdSync.py +0 -0
  174. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPOsdSync.pyi +0 -0
  175. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPPowerSave.py +0 -0
  176. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPPowerSave.pyi +0 -0
  177. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPPrivacy.py +0 -0
  178. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPPrivacy.pyi +0 -0
  179. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSetMaster.py +0 -0
  180. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSetMaster.pyi +0 -0
  181. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSettingsAll.py +0 -0
  182. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSettingsAll.pyi +0 -0
  183. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSinkSdp.py +0 -0
  184. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSinkSdp.pyi +0 -0
  185. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSourceSwitch.py +0 -0
  186. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSourceSwitch.pyi +0 -0
  187. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSources.py +0 -0
  188. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPSources.pyi +0 -0
  189. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPStats.py +0 -0
  190. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPStats.pyi +0 -0
  191. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPTestcard.py +0 -0
  192. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPTestcard.pyi +0 -0
  193. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPTiling.pyi +0 -0
  194. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPVideoWall.py +0 -0
  195. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameV2IPVideoWall.pyi +0 -0
  196. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolume.py +0 -0
  197. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolume.pyi +0 -0
  198. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeDown.py +0 -0
  199. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeDown.pyi +0 -0
  200. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeSet.py +0 -0
  201. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeSet.pyi +0 -0
  202. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeUp.py +0 -0
  203. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/FrameVolumeUp.pyi +0 -0
  204. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/LinkConfig.py +0 -0
  205. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/LinkConfig.pyi +0 -0
  206. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Multiviewer.py +0 -0
  207. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Multiviewer.pyi +0 -0
  208. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Svd.py +0 -0
  209. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/Svd.pyi +0 -0
  210. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/V2IPConfig.py +0 -0
  211. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/V2IPConfig.pyi +0 -0
  212. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/V2IPStats.py +0 -0
  213. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/V2IPStats.pyi +0 -0
  214. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/__init__.py +0 -0
  215. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/__init__.pyi +0 -0
  216. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/proto/svd.csv +0 -0
  217. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/py.typed +0 -0
  218. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/AudioRoute.py +0 -0
  219. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/AudioRoute.pyi +0 -0
  220. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Bay.py +0 -0
  221. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Bay.pyi +0 -0
  222. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/ConnectionAsync.py +0 -0
  223. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/ConnectionAsync.pyi +0 -0
  224. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Link.py +0 -0
  225. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Link.pyi +0 -0
  226. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/OsdSync.py +0 -0
  227. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/OsdSync.pyi +0 -0
  228. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Remote.pyi +0 -0
  229. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/State.py +0 -0
  230. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/State.pyi +0 -0
  231. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Tree.py +0 -0
  232. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/Tree.pyi +0 -0
  233. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/V2IP.py +0 -0
  234. {mx_remote-11.0.0 → mx_remote-12.0.0}/mx_remote/remote/V2IP.pyi +0 -0
  235. {mx_remote-11.0.0 → mx_remote-12.0.0}/pyproject.toml +0 -0
  236. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/audio_ir.py +0 -0
  237. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/audiolock.py +0 -0
  238. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/audioroute.py +0 -0
  239. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/baycontent.py +0 -0
  240. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/capture.py +0 -0
  241. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/complete.py +0 -0
  242. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/connect.py +0 -0
  243. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/deprecated.py +0 -0
  244. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/downmix.py +0 -0
  245. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/e2e.py +0 -0
  246. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/endpoints.py +0 -0
  247. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/entry.py +0 -0
  248. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/handlers.py +0 -0
  249. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/handlers_cover.py +0 -0
  250. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/hello.py +0 -0
  251. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/idempotent.py +0 -0
  252. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/lengths.py +0 -0
  253. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/merge.py +0 -0
  254. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/mesh.py +0 -0
  255. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/meshbays.py +0 -0
  256. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/newops.py +0 -0
  257. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/offline.py +0 -0
  258. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/offsets.py +0 -0
  259. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/oneiproute.py +0 -0
  260. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/osdmessage.py +0 -0
  261. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/osdsync.py +0 -0
  262. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/ping.py +0 -0
  263. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/privacy.py +0 -0
  264. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/proto_stamp.py +0 -0
  265. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/protogate.py +0 -0
  266. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/registry.py +0 -0
  267. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/roundtrip.py +0 -0
  268. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/routes.py +0 -0
  269. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/run.py +0 -0
  270. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/smoke.py +0 -0
  271. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/sources.py +0 -0
  272. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/staterequest.py +0 -0
  273. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/stats.py +0 -0
  274. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/structs.py +0 -0
  275. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/thirdparty.py +0 -0
  276. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/txresult.py +0 -0
  277. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/uid.py +0 -0
  278. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/unknowns.py +0 -0
  279. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipptp.py +0 -0
  280. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipscaling.py +0 -0
  281. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipsdp.py +0 -0
  282. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipsettings.py +0 -0
  283. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipsubject.py +0 -0
  284. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2iptestcard.py +0 -0
  285. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/v2ipvlan.py +0 -0
  286. {mx_remote-11.0.0 → mx_remote-12.0.0}/tests/vdetails.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: mx_remote
3
- Version: 11.0.0
3
+ Version: 12.0.0
4
4
  Summary: Python 3 library for interfacing with MX Remote compatible devices
5
5
  Project-URL: Homepage, https://github.com/opdenkamp/mx-remote/
6
6
  Project-URL: Documentation, https://opdenkamp.github.io/mx-remote/
@@ -128,6 +128,15 @@ The key and action codes a bay reports, and the target a key was aimed at.
128
128
  :members:
129
129
  :undoc-members:
130
130
 
131
+ .. autoclass:: mx_remote.proto.Constants.RCStatus
132
+ :members:
133
+ :undoc-members:
134
+
135
+ .. autoclass:: mx_remote.RCSettings
136
+ :members:
137
+
138
+ .. autodata:: mx_remote.KEEP_REPORTED
139
+
131
140
  .. autodata:: mx_remote.proto.Constants.MXR_PROTOCOL_VERSION
132
141
  ```
133
142
 
@@ -189,10 +198,22 @@ How a device's output mixes 5.1 and 7.1 PCM down to stereo.
189
198
 
190
199
  ## OneIP locale
191
200
 
192
- The locale a device runs, by its number.
201
+ The locale a device runs, by its name, such as `NL_NL`.
193
202
 
194
203
  ```{eval-rst}
195
- .. autodata:: mx_remote.proto.Constants.ONEIP_LOCALE_UNKNOWN
204
+ .. autodata:: mx_remote.proto.Constants.ONEIP_LOCALE_MAX
205
+ ```
206
+
207
+ ## OneIP tiling
208
+
209
+ The window a OneIP output takes for a video wall.
210
+
211
+ ```{eval-rst}
212
+ .. autodata:: mx_remote.proto.Constants.ONEIP_TILING_X_STEP
213
+
214
+ .. autodata:: mx_remote.proto.Constants.ONEIP_TILING_WIDTH_STEP
215
+
216
+ .. autodata:: mx_remote.proto.Constants.ONEIP_TILING_MIN
196
217
  ```
197
218
 
198
219
  ## OneIP PTP
@@ -377,27 +377,29 @@ runs on to 248 bytes and carries no other setting.
377
377
 
378
378
  ### Locale
379
379
 
380
- A device whose firmware has locales reports the one it runs by its number, its
381
- position in the list the device's `/system/locale` names, behind the downmix.
382
- `ONEIP_LOCALE_UNKNOWN` is a stored locale the firmware does not know.
380
+ A device whose firmware has locales reports the one it runs by its name, such
381
+ as `NL_NL`: up to `ONEIP_LOCALE_MAX` bytes, NUL padded, at the end of its
382
+ settings block, behind the preview group.
383
383
 
384
384
  ```python
385
- print(device.oneip_locale) # None: no report yet, or no locales
386
- await device.set_oneip_locale(1)
385
+ print(device.oneip_locale) # 'EN_UK', or None: no report yet, or no locales
386
+ await device.set_oneip_locale('NL_NL')
387
387
  ```
388
388
 
389
389
  A device stores a locale it knows and ignores one it does not, so the write goes
390
390
  also to a device that has not reported its settings yet, and the locale is
391
- cached once sent until the device's next report. Refused before sending:
392
- `ONEIP_LOCALE_UNKNOWN`, a number that is not a byte, and a device whose settings
393
- arrived without a locale, as its firmware has none. Another controller's write
394
- reaches only a device that reports a locale.
391
+ cached once sent until the device's next report. The write runs on to 256
392
+ bytes, as a device takes a locale only from a block that holds the whole name.
393
+ Refused before sending: a name that is empty, longer than `ONEIP_LOCALE_MAX`
394
+ bytes or not printable ASCII, and a device whose settings arrived without a
395
+ locale, as its firmware has none. Another controller's write reaches only a
396
+ device that reports a locale.
395
397
 
396
398
  ### Live preview
397
399
 
398
400
  A device whose firmware sends a live preview names the multicast group it sends
399
401
  it to at the end of its settings block. The preview is RFC 2435 RTP/JPEG on
400
- UDP port `ONEIP_PREVIEW_PORT` (5880).
402
+ UDP port `ONEIP_PREVIEW_PORT` (50024), after the stream ports.
401
403
 
402
404
  ```python
403
405
  from mx_remote.proto.Constants import ONEIP_PREVIEW_PORT
@@ -534,6 +536,11 @@ save then takes this content rather than the controller's. Logo images are
534
536
  served over HTTP from this client, on `logo_port` or a free port. Content a unit
535
537
  would refuse is refused before anything is sent; see `send_osd_sync`.
536
538
 
539
+ A caption setting with `OsdCaptionField.DEFAULT_TEXT` in place of
540
+ `OsdCaptionField.TEXT`, and no text, sends a unit back to its layout's default
541
+ caption, drawn in its own locale. A unit whose firmware predates it keeps the
542
+ text it has.
543
+
537
544
  ### Overlay messages
538
545
 
539
546
  A unit shows a message on its output, over the picture, until it restarts. The
@@ -637,6 +644,9 @@ await device.stop_locating_unit()
637
644
  A unit is located only once its status carries `UnitFlag.LOCATE_SUPPORTED`. Its
638
645
  board-ID LED flashes and an output shows "Locate Device"; `UnitFlag.LOCATE` in
639
646
  the cached status says so from the moment the command is sent.
647
+ `UnitFlag.FIRMWARE_UPGRADE` says the update service offered the unit a firmware
648
+ upgrade, and `UnitFlag.UPGRADE_INSTALLING` that it is writing one to its flash,
649
+ with its picture gone until it restarts.
640
650
 
641
651
  A changed IP configuration applies at once and reverts unless the mesh
642
652
  controller confirms it in time; `status.network_pending` says whether it still
@@ -669,7 +679,8 @@ the source's next configuration report carries the addresses it ends up with, in
669
679
  A client can stand in for a unit as mesh controller. It announces itself as a
670
680
  mesh device rather than a management application, so a mesh takes it as a
671
681
  member, and under a serial and version of its own so the device list tells it
672
- apart from the unit it replaces:
682
+ apart from the unit it replaces. A unit counts a mesh device without bays as a
683
+ member only under a serial that is `P9SN00000000` or does not start `P9SN0000`:
673
684
 
674
685
  ```python
675
686
  from mx_remote import MeshOperationMessage
@@ -688,8 +699,26 @@ await output.set_oneip_source_filter([source.remote_id])
688
699
  await output.set_oneip_tiling(pos_x=0, pos_y=0, width=1920, height=1080)
689
700
  await unit.set_rc_settings(rc_target=RCType.CEC, ip=None, cec_enabled=True, cec_auto_on=True,
690
701
  forward_rc=True, forward_ir=False)
702
+ await unit.set_rc_settings(forward_ir=True) # the rest as the unit reported
691
703
  ```
692
704
 
705
+ The tiling window is in pixels of the decoded source picture: the output crops
706
+ it out and scales it up. A width or height of 0 shows the whole picture. An
707
+ output ignores, without a word, a window whose `pos_x` is not a multiple of
708
+ `ONEIP_TILING_X_STEP` (64), whose width is not a multiple of
709
+ `ONEIP_TILING_WIDTH_STEP` (4), or whose sides are under `ONEIP_TILING_MIN` (64),
710
+ so the library refuses those before sending. The output keeps a window in
711
+ memory only and does not report it: a reboot, a stream restart or a change of
712
+ source format drops it.
713
+
714
+ Every unit reports its remote control settings itself, periodically and right
715
+ after a change, and `unit.rc_settings` holds the last report (an `RCSettings`).
716
+ A report is what runs, not what is stored: `rc_type` is the driver in use, and
717
+ the CEC switches read False while the unit's CEC module is not loaded. A
718
+ setting `set_rc_settings()` is not given, or `ip` left at `KEEP_REPORTED`, is
719
+ sent as last reported, so it can store what runs; it is refused until the unit
720
+ has reported.
721
+
693
722
  `set_mesh_controller()` changes only the announcement, at once: membership
694
723
  while there is a controller, and the controller role while it is this client
695
724
  and `set_mesh_bays_mapped()` says it has bays, as a unit announces it.
@@ -725,10 +754,10 @@ await output.unroute_oneip_unit() # names no streams
725
754
  Each powers the output's display on with the switch unless `power_on=False`. An
726
755
  output below protocol 0x27 is told the source's own audio rather than none, as
727
756
  `select_video_source()` does. `route_oneip_unit_with_arc()` names the audio
728
- return group the other unit last reported in `oneip_details.arc`; no unit maps
729
- that group to a bay, so on current firmware the output plays it on the default
730
- audio port, 50022, while the audio return is sent on 50023, and such a route
731
- plays no audio. It is what a controller sends all the same. A route is refused
757
+ return group the other unit last reported in `oneip_details.arc`. The output
758
+ resolves that group to the other unit's audio return, but audio return is
759
+ compiled out of OneIP firmware, so such a route plays no audio. It is what a
760
+ controller sends all the same. A route is refused
732
761
  before anything is sent where the device is not a OneIP output, a source has no
733
762
  input of its own or has not reported its stream addresses, or the other unit has
734
763
  not reported a usable audio return group.
@@ -8,7 +8,7 @@
8
8
  from abc import ABC, abstractmethod
9
9
  from dataclasses import dataclass, replace
10
10
  from datetime import datetime, timezone
11
- from enum import IntEnum
11
+ from enum import Enum, IntEnum
12
12
  import time
13
13
  import warnings
14
14
  from functools import cached_property
@@ -2322,6 +2322,48 @@ class OneIPDownmix:
2322
2322
  if (self.status is not None) else "status unknown")
2323
2323
  return f"{mode} {level} lfe {self.lfe}% {status}"
2324
2324
 
2325
+ class KeepReported(Enum):
2326
+ '''The type of KEEP_REPORTED.'''
2327
+ KEEP = 'keep'
2328
+
2329
+ KEEP_REPORTED = KeepReported.KEEP
2330
+ '''Keep the value the device reported, for an argument where None is a value
2331
+ of its own.'''
2332
+
2333
+ @dataclass(frozen=True)
2334
+ class RCSettings:
2335
+ """
2336
+ A unit's remote control and CEC settings, as the unit reports them.
2337
+
2338
+ The unit reports what runs, which is not always what it stores: rc_type is
2339
+ the driver in use, and the CEC switches read False while its CEC module is
2340
+ not loaded.
2341
+ """
2342
+ rc_type: RCType|None
2343
+ """How the controlled device is driven; None for a driver this library
2344
+ does not name."""
2345
+ ip: str|None
2346
+ """The controlled device's IPv4 address, None for none."""
2347
+ cec_enabled: bool
2348
+ """Whether the controlled device is driven over CEC."""
2349
+ cec_auto_on: bool
2350
+ """Whether the controlled device is powered on over CEC."""
2351
+ forward_rc: bool
2352
+ """Whether remote control commands are forwarded to the controlled
2353
+ device."""
2354
+ forward_ir: bool
2355
+ """Whether IR commands are forwarded to the controlled device."""
2356
+ rc_status: RCStatus|int
2357
+ """The driver's state; a raw int for a state this library does not name."""
2358
+ status_name: str|None
2359
+ """The driver's status text, None for none."""
2360
+
2361
+ def __str__(self) -> str:
2362
+ rc_type = self.rc_type.name if (self.rc_type is not None) else 'unknown'
2363
+ flags = [n for n, v in (("cec", self.cec_enabled), ("cec auto-on", self.cec_auto_on),
2364
+ ("rc forward", self.forward_rc), ("ir forward", self.forward_ir)) if v]
2365
+ return f"{rc_type} ip {self.ip} status {self.rc_status} '{self.status_name or ''}' [{', '.join(flags)}]"
2366
+
2325
2367
  @dataclass(frozen=True)
2326
2368
  class OneIPVlan:
2327
2369
  """
@@ -3668,11 +3710,16 @@ class DeviceBase(ABC):
3668
3710
 
3669
3711
  @property
3670
3712
  @abstractmethod
3671
- def oneip_locale(self) -> int|None:
3672
- '''The locale this OneIP device runs, by its number, as it last reported
3673
- or as it was last written; None while it reports none, and always for
3674
- one whose firmware has no locales. ONEIP_LOCALE_UNKNOWN is a stored
3675
- locale its firmware does not know.'''
3713
+ def oneip_locale(self) -> str|None:
3714
+ '''The locale this OneIP device runs, by its name, such as NL_NL, as it
3715
+ last reported or as it was last written; None while it reports none,
3716
+ and always for one whose firmware has no locales.'''
3717
+
3718
+ @property
3719
+ @abstractmethod
3720
+ def rc_settings(self) -> RCSettings|None:
3721
+ '''This unit's remote control and CEC settings as it last reported
3722
+ them, None until it reports.'''
3676
3723
 
3677
3724
  @property
3678
3725
  @abstractmethod
@@ -3952,7 +3999,7 @@ class DeviceBase(ABC):
3952
3999
 
3953
4000
  @abstractmethod
3954
4001
  async def set_oneip_tiling(self, pos_x:int, pos_y:int, width:int, height:int) -> bool:
3955
- '''set the part of a video wall this OneIP output shows'''
4002
+ '''set the window of the source picture, in pixels, this OneIP output crops out and scales up for a video wall'''
3956
4003
 
3957
4004
  @abstractmethod
3958
4005
  async def route_oneip_unit(self, video:'DeviceBase', audio:'DeviceBase|None'=None, power_on:bool=True) -> bool:
@@ -3967,9 +4014,11 @@ class DeviceBase(ABC):
3967
4014
  '''unroute this OneIP output, as a mesh controller does'''
3968
4015
 
3969
4016
  @abstractmethod
3970
- async def set_rc_settings(self, rc_target:RCType|int, ip:str|None, cec_enabled:bool, cec_auto_on:bool,
3971
- forward_rc:bool, forward_ir:bool, rc_status:int=0, status_name:str='') -> bool:
3972
- '''change this OneIP unit's remote control and CEC settings'''
4017
+ async def set_rc_settings(self, rc_target:RCType|int|None=None, ip:str|None|KeepReported=KEEP_REPORTED,
4018
+ cec_enabled:bool|None=None, cec_auto_on:bool|None=None,
4019
+ forward_rc:bool|None=None, forward_ir:bool|None=None,
4020
+ rc_status:int=0, status_name:str='') -> bool:
4021
+ '''change this OneIP unit's remote control and CEC settings; a setting left out keeps the value the unit reported'''
3973
4022
 
3974
4023
  @abstractmethod
3975
4024
  async def read_stats(self, enable:bool) -> bool:
@@ -4044,8 +4093,8 @@ class DeviceBase(ABC):
4044
4093
  '''confirm the VLAN configuration the device runs pending, so it keeps it'''
4045
4094
 
4046
4095
  @abstractmethod
4047
- async def set_oneip_locale(self, locale:int) -> bool:
4048
- '''set the locale the device runs, by its number'''
4096
+ async def set_oneip_locale(self, locale:str) -> bool:
4097
+ '''set the locale the device runs, by its name, such as NL_NL'''
4049
4098
 
4050
4099
  @abstractmethod
4051
4100
  async def set_oneip_skip_420(self, enabled:bool) -> bool:
@@ -10,7 +10,7 @@ from _typeshed import Incomplete
10
10
  from abc import ABC, abstractmethod
11
11
  from dataclasses import dataclass
12
12
  from datetime import datetime
13
- from enum import IntEnum
13
+ from enum import Enum, IntEnum
14
14
  from functools import cached_property
15
15
  from typing import Any, Callable, NamedTuple
16
16
 
@@ -823,6 +823,22 @@ class OneIPDownmix:
823
823
  def is_valid(self) -> bool: ...
824
824
  def written(self, write: OneIPDownmix) -> OneIPDownmix: ...
825
825
 
826
+ class KeepReported(Enum):
827
+ KEEP: str
828
+
829
+ KEEP_REPORTED: Incomplete
830
+
831
+ @dataclass(frozen=True)
832
+ class RCSettings:
833
+ rc_type: RCType | None
834
+ ip: str | None
835
+ cec_enabled: bool
836
+ cec_auto_on: bool
837
+ forward_rc: bool
838
+ forward_ir: bool
839
+ rc_status: RCStatus | int
840
+ status_name: str | None
841
+
826
842
  @dataclass(frozen=True)
827
843
  class OneIPVlan:
828
844
  flags: OneIPVlanFlag = ...
@@ -1328,7 +1344,10 @@ class DeviceBase(ABC):
1328
1344
  def oneip_downmix(self) -> OneIPDownmix | None: ...
1329
1345
  @property
1330
1346
  @abstractmethod
1331
- def oneip_locale(self) -> int | None: ...
1347
+ def oneip_locale(self) -> str | None: ...
1348
+ @property
1349
+ @abstractmethod
1350
+ def rc_settings(self) -> RCSettings | None: ...
1332
1351
  @property
1333
1352
  @abstractmethod
1334
1353
  def oneip_preview(self) -> str | None: ...
@@ -1467,7 +1486,7 @@ class DeviceBase(ABC):
1467
1486
  @abstractmethod
1468
1487
  async def unroute_oneip_unit(self) -> bool: ...
1469
1488
  @abstractmethod
1470
- async def set_rc_settings(self, rc_target: RCType | int, ip: str | None, cec_enabled: bool, cec_auto_on: bool, forward_rc: bool, forward_ir: bool, rc_status: int = 0, status_name: str = '') -> bool: ...
1489
+ async def set_rc_settings(self, rc_target: RCType | int | None = None, ip: str | None | KeepReported = ..., cec_enabled: bool | None = None, cec_auto_on: bool | None = None, forward_rc: bool | None = None, forward_ir: bool | None = None, rc_status: int = 0, status_name: str = '') -> bool: ...
1471
1490
  @abstractmethod
1472
1491
  async def read_stats(self, enable: bool) -> bool: ...
1473
1492
  @abstractmethod
@@ -1505,7 +1524,7 @@ class DeviceBase(ABC):
1505
1524
  @abstractmethod
1506
1525
  async def confirm_oneip_vlan(self) -> bool: ...
1507
1526
  @abstractmethod
1508
- async def set_oneip_locale(self, locale: int) -> bool: ...
1527
+ async def set_oneip_locale(self, locale: str) -> bool: ...
1509
1528
  @abstractmethod
1510
1529
  async def set_oneip_skip_420(self, enabled: bool) -> bool: ...
1511
1530
  @abstractmethod
@@ -14,7 +14,7 @@ Default communication modes:
14
14
  """
15
15
  import os
16
16
 
17
- VERSION = '11.0.0'
17
+ VERSION = '12.0.0'
18
18
  __version__ = VERSION
19
19
 
20
20
  MX_BCAST_UDP_PORT = 8811
@@ -271,7 +271,10 @@ class DeviceFeature(IntFlag):
271
271
  OSD_SYNC = (1 << 29)
272
272
  '''Copies the overlay settings and logos of another unit when asked.'''
273
273
  STATUS_UPGRADING = (1 << 30)
274
- '''Is downloading or installing a firmware or video processor upgrade. STATUS_REBOOTING follows when it reboots to complete it.'''
274
+ '''Is downloading or installing a firmware or video processor upgrade,
275
+ across every partition of a video processor upgrade, until the unit
276
+ restarts and STATUS_REBOOTING follows, or its video processor does. A OneIP
277
+ unit's status tells the install itself by UnitFlag.UPGRADE_INSTALLING.'''
275
278
  BOOT_BIT = (1 << 31)
276
279
  '''Flips on every reboot, so a peer that sees it change knows the device restarted.'''
277
280
 
@@ -512,6 +515,11 @@ class OsdCaptionField(IntFlag):
512
515
  COLOUR = (1 << 6)
513
516
  WRAP = (1 << 7)
514
517
  TEXT = (1 << 8)
518
+ DEFAULT_TEXT = (1 << 15)
519
+ '''The layout's default text, in place of TEXT and with no text given: the
520
+ unit goes back to its default caption, drawn in its own locale, before the
521
+ other fields apply. A unit whose firmware predates it keeps the text it
522
+ has.'''
515
523
 
516
524
  class OsdLogoField(IntFlag):
517
525
  '''The logo fields an overlay setting gives. A field left out keeps what the
@@ -636,14 +644,19 @@ class OneIPDownmixLevel(IntEnum):
636
644
  ONEIP_DOWNMIX_LFE_MAX = 100
637
645
  """The largest percent a OneIP output mixes its LFE channel in at."""
638
646
 
639
- ONEIP_LOCALE_UNKNOWN = 255
640
- """The locale a OneIP device reports for a stored locale its firmware does not
641
- know. Every other value numbers a locale, and keeps its meaning across firmware
642
- versions."""
647
+ ONEIP_LOCALE_MAX = 8
648
+ """The longest locale name a OneIP device reports or takes, in bytes."""
643
649
 
644
- ONEIP_PREVIEW_PORT = 5880
650
+ ONEIP_TILING_X_STEP = 64
651
+ """A OneIP output's tiling window starts at a multiple of this many pixels."""
652
+ ONEIP_TILING_WIDTH_STEP = 4
653
+ """A OneIP output's tiling window is a multiple of this many pixels wide."""
654
+ ONEIP_TILING_MIN = 64
655
+ """The fewest pixels a OneIP output's tiling window is wide and high."""
656
+
657
+ ONEIP_PREVIEW_PORT = 50024
645
658
  """The UDP port a OneIP unit sends its live preview to, as RFC 2435 RTP/JPEG,
646
- on the group it reports as Device.oneip_preview."""
659
+ on the group it reports as Device.oneip_preview, after its stream ports."""
647
660
 
648
661
  class UnitPowerSave(IntFlag):
649
662
  '''What a unit offers at one power save level.'''
@@ -699,6 +712,12 @@ class UnitFlag(IntFlag):
699
712
  LOCATE = (1 << 17)
700
713
  '''The unit is being located: its board-ID LED flashes, and an output shows
701
714
  "Locate Device".'''
715
+ FIRMWARE_UPGRADE = (1 << 18)
716
+ '''The update service offered the unit a firmware upgrade, which waits to be
717
+ installed or is downloading or installing.'''
718
+ UPGRADE_INSTALLING = (1 << 19)
719
+ '''The unit is writing an upgrade to its firmware or video processor flash,
720
+ until it restarts. Its picture is gone meanwhile.'''
702
721
 
703
722
  class UnitCommandKind(IntEnum):
704
723
  '''What a unit command asks of its unit.'''
@@ -177,6 +177,7 @@ class OsdCaptionField(IntFlag):
177
177
  COLOUR: Incomplete
178
178
  WRAP: Incomplete
179
179
  TEXT: Incomplete
180
+ DEFAULT_TEXT: Incomplete
180
181
 
181
182
  class OsdLogoField(IntFlag):
182
183
  LOGO: Incomplete
@@ -246,7 +247,10 @@ class OneIPDownmixLevel(IntEnum):
246
247
  UNSCALED: int
247
248
 
248
249
  ONEIP_DOWNMIX_LFE_MAX: int
249
- ONEIP_LOCALE_UNKNOWN: int
250
+ ONEIP_LOCALE_MAX: int
251
+ ONEIP_TILING_X_STEP: int
252
+ ONEIP_TILING_WIDTH_STEP: int
253
+ ONEIP_TILING_MIN: int
250
254
  ONEIP_PREVIEW_PORT: int
251
255
 
252
256
  class UnitPowerSave(IntFlag):
@@ -275,6 +279,8 @@ class UnitFlag(IntFlag):
275
279
  FAN_SPEED: Incomplete
276
280
  LOCATE_SUPPORTED: Incomplete
277
281
  LOCATE: Incomplete
282
+ FIRMWARE_UPGRADE: Incomplete
283
+ UPGRADE_INSTALLING: Incomplete
278
284
 
279
285
  class UnitCommandKind(IntEnum):
280
286
  CLEAR_STATUS: int
@@ -45,8 +45,10 @@ class FrameHello(FrameBase):
45
45
  grow its own.'''
46
46
  payload = [ (MXR_PROTOCOL_VERSION & 0xFF), ((MXR_PROTOCOL_VERSION >> 8) & 0xFF) ]
47
47
  payload = append_payload_str(payload=payload, value=mxr.name, sz=16)
48
- payload = append_payload_str(payload=payload, value=getattr(mxr, 'serial', CLIENT_SERIAL), sz=16)
49
- payload = append_payload_str(payload=payload, value=getattr(mxr, 'version', __version__), sz=16)
48
+ # A unit reads the serial and version up to their first zero byte, so
49
+ # one filling its 16 bytes would run on into the field after it.
50
+ payload = append_payload_str(payload=payload, value=getattr(mxr, 'serial', CLIENT_SERIAL), sz=15) + [0]
51
+ payload = append_payload_str(payload=payload, value=getattr(mxr, 'version', __version__), sz=15) + [0]
50
52
  features = FrameHello.announced_features(mxr)
51
53
  payload += [ (features >> 0) & 0xFF, (features >> 8) & 0xFF, (features >> 16) & 0xFF, (features >> 24) & 0xFF ]
52
54
  return FrameBase.construct_base(mxr=mxr, opcode=0, payload=bytes(payload))
@@ -9,7 +9,7 @@
9
9
  from functools import cached_property
10
10
  from .FrameBase import FrameBase, append_payload_str
11
11
  from .Constants import RCStatus, RCType, MXR_RC_STATUS_NAME_LEN
12
- from ..Interface import DeviceBase, DeviceRegistry
12
+ from ..Interface import DeviceBase, DeviceRegistry, RCSettings
13
13
  from ..Uid import MxrDeviceUid
14
14
  import socket
15
15
  import struct
@@ -39,7 +39,7 @@ _STATUS_NAME_SIZE = MXR_RC_STATUS_NAME_LEN + 1
39
39
  _WIRE_SIZE = 48
40
40
 
41
41
  class FrameRCSettings(FrameBase):
42
- '''Remote control settings for one device, forwarded from a source to the master.'''
42
+ '''A unit's remote control settings: its own report, or a write naming it.'''
43
43
  @staticmethod
44
44
  def construct(mxr:DeviceRegistry, target:DeviceBase, rc_target:int, ip:str|None, cec_enabled:bool,
45
45
  cec_auto_on:bool, forward_rc:bool, forward_ir:bool, rc_status:int, status_name:str) -> FrameBase|None:
@@ -146,9 +146,27 @@ class FrameRCSettings(FrameBase):
146
146
  return None
147
147
  return name
148
148
 
149
+ @cached_property
150
+ def settings(self) -> RCSettings|None:
151
+ '''The settings the frame carries, None when it is too short to carry them.'''
152
+ if (self._flags is None) or (self.rc_status is None):
153
+ return None
154
+ return RCSettings(rc_type=self.rc_target, ip=self.ip,
155
+ cec_enabled=bool(self.cec_enabled), cec_auto_on=bool(self.cec_auto_on),
156
+ forward_rc=bool(self.rc_forward), forward_ir=bool(self.ir_forward),
157
+ rc_status=self.rc_status, status_name=self.status_name)
158
+
149
159
  def process(self) -> None:
150
- '''No-op: settings for a target, reported for visibility rather than cached.'''
151
- pass
160
+ '''Keep the settings a unit reports for itself.
161
+
162
+ A write names another unit, and that unit reports what it applied, so
163
+ only a unit's own report is kept.
164
+ '''
165
+ if (self.target_uid is None) or (self.target_uid != self.remote_id):
166
+ return
167
+ if ((dev := self.remote_device) is None) or ((settings := self.settings) is None):
168
+ return
169
+ dev.on_mxr_update(settings)
152
170
 
153
171
  def __str__(self) -> str:
154
172
  target = self.target_device if (self.target_device is not None) else self.target_uid
@@ -1,4 +1,4 @@
1
- from ..Interface import DeviceBase as DeviceBase, DeviceRegistry as DeviceRegistry
1
+ from ..Interface import DeviceBase as DeviceBase, DeviceRegistry as DeviceRegistry, RCSettings as RCSettings
2
2
  from ..Uid import MxrDeviceUid as MxrDeviceUid
3
3
  from .Constants import MXR_RC_STATUS_NAME_LEN as MXR_RC_STATUS_NAME_LEN, RCStatus as RCStatus, RCType as RCType
4
4
  from .FrameBase import FrameBase as FrameBase, append_payload_str as append_payload_str
@@ -27,4 +27,6 @@ class FrameRCSettings(FrameBase):
27
27
  def rc_status(self) -> RCStatus | int | None: ...
28
28
  @cached_property
29
29
  def status_name(self) -> str | None: ...
30
+ @cached_property
31
+ def settings(self) -> RCSettings | None: ...
30
32
  def process(self) -> None: ...
@@ -16,7 +16,7 @@ from ..Interface import (DeviceBase, DeviceRegistry, DeviceOneIPDetails, DeviceO
16
16
  DeviceOneIPSink, OneIPAudioFormat, OneIPDeviceSettings, OneIPDscpConfig,
17
17
  OneIPDownmix, OneIPDownmixStatus, OneIPPowerSaveSchedule, OneIPPtpMessages, OneIPPtpState,
18
18
  OneIPStreamSource, OneIPVlan, _wire_enum)
19
- from .Constants import (ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_DEVICE_SETTINGS_PTP, OneIPDownmixLevel, OneIPDownmixMode, OneIPPtpFlag, OneIPPtpLock, OneIPPtpMode, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag, MXR_SCALING_FLAG_AUTO_SCALING,
19
+ from .Constants import (ONEIP_DEVICE_SETTINGS_BLOCK, ONEIP_LOCALE_MAX, ONEIP_DEVICE_SETTINGS_PTP, OneIPDownmixLevel, OneIPDownmixMode, OneIPPtpFlag, OneIPPtpLock, OneIPPtpMode, OneIPDeviceSetting, OneIPVideoProcessorFeature, OneIPVlanFlag, MXR_SCALING_FLAG_AUTO_SCALING,
20
20
  MXR_SCALING_FLAG_MODE_VALID,
21
21
  MXR_SCALING_FLAG_OPTIONS_VALID, MXR_SCALING_FLAG_OPTIONS2_VALID,
22
22
  MXR_SCALING_OPTIONS2_SETTINGS, MXR_ONEIP_DSCP_SET, MxrSignalType,
@@ -53,9 +53,10 @@ from .V2IPConfig import V2IPStreamSourceImpl, parse_v2ip_av_source
53
53
  # reserved
54
54
  # 232..248 from a device with the downmix: u32 second valid word, then
55
55
  # the downmix's u8 mode, level, LFE percent, state and channels
56
- # at 236..241, then from a device with locales the u8 locale at
57
- # 241, 2 reserved, and from a device with a live preview its
58
- # group at 244..248, an address in network order
56
+ # at 236..241, 3 reserved, then from a device with a live
57
+ # preview its group at 244..248, an address in network order
58
+ # 248..256 from a device with locales the locale's name, such as NL_NL,
59
+ # NUL padded
59
60
  #
60
61
  # That block is the last of its frame, so it is read by its length: shorter
61
62
  # than 8 carries none of its values, and 8, which every device without the TTL
@@ -63,8 +64,9 @@ from .V2IPConfig import V2IPStreamSourceImpl, parse_v2ip_av_source
63
64
  # the TTL or the rotation, and to 32 only for the downmix, so the frames other
64
65
  # writes send are unchanged for units that predate them. A block too short to
65
66
  # hold the downmix's channels carries no bit of the second valid word, one too
66
- # short to hold the locale says nothing about it, and one too short to hold the
67
- # preview group, like a group of 0, is firmware that sends no preview.
67
+ # short to hold the preview group, like a group of 0, is firmware that sends no
68
+ # preview, and one too short to hold the whole locale name says nothing about
69
+ # the locale.
68
70
  #
69
71
  # Each of those blocks was appended behind what came before it, leaving every
70
72
  # offset ahead of it where it was, so the length is what says whether one is
@@ -150,14 +152,13 @@ _VALID_EXT_OFFSET = SETTINGS_BLOCK_OFFSET + _SETTINGS_BLOCK_LONG_SIZE
150
152
  '''The second valid word of the settings, behind the block of their own.'''
151
153
  _DOWNMIX_OFFSET = _VALID_EXT_OFFSET + 4
152
154
  _DOWNMIX_SIZE = 5
153
- _LOCALE_AT = _DOWNMIX_OFFSET + _DOWNMIX_SIZE
154
- '''The locale's number, behind the downmix.'''
155
- _PREVIEW_AT = _LOCALE_AT + 3
156
- '''The live preview's group, behind the locale and two reserved bytes.'''
155
+ _PREVIEW_AT = _DOWNMIX_OFFSET + _DOWNMIX_SIZE + 3
156
+ '''The live preview's group, behind the downmix and three reserved bytes.'''
157
157
  _PREVIEW_SIZE = 4
158
+ _LOCALE_AT = _PREVIEW_AT + _PREVIEW_SIZE
159
+ '''The locale's name, NUL padded, at the end of the settings block.'''
158
160
  _WITH_DOWNMIX_SIZE = SETTINGS_BLOCK_OFFSET + 32
159
- '''The frame a downmix or locale write sends: the settings block run on to 32
160
- bytes.'''
161
+ '''The frame a downmix write sends: the settings block run on to 32 bytes.'''
161
162
  _SETTING_EXT_DOWNMIX = 1 << 0
162
163
  '''The bit of the second valid word that carries the downmix.'''
163
164
  _SETTING_EXT_LOCALE = 1 << 1
@@ -493,20 +494,23 @@ class FrameV2IPDeviceConfiguration(FrameBase):
493
494
 
494
495
  @staticmethod
495
496
  def construct_locale(mxr:DeviceRegistry, target:Any, target_uid:MxrDeviceUid,
496
- locale:int) -> FrameBase|None:
497
+ locale:str) -> FrameBase|None:
497
498
  '''Build the 0x3C write that changes a device's locale and nothing else.
498
499
 
499
- 248 bytes, as construct_downmix() builds them, with the second valid
500
- word carrying the locale alone and its number at 241.
500
+ 256 bytes, as construct_downmix() builds them and then the preview group
501
+ left 0 and the locale's name at 248, NUL padded, with the second valid
502
+ word carrying the locale alone. A device takes the locale only from a
503
+ block that holds the whole name. The caller keeps the name to
504
+ ONEIP_LOCALE_MAX printable ASCII bytes.
501
505
  '''
502
506
  frame = FrameV2IPDeviceConfiguration.construct_settings(
503
507
  mxr=mxr, target=target, target_uid=target_uid, settings=OneIPDeviceSettings())
504
508
  if (frame is None):
505
509
  return None
506
510
  payload = bytearray(frame.payload or b"")
507
- payload += bytes(_WITH_DOWNMIX_SIZE - len(payload))
511
+ payload += bytes(_LOCALE_AT - len(payload))
508
512
  struct.pack_into('<I', payload, _VALID_EXT_OFFSET, _SETTING_EXT_LOCALE)
509
- payload[_LOCALE_AT] = locale
513
+ payload += locale.encode('ascii').ljust(ONEIP_LOCALE_MAX, b'\0')
510
514
  return FrameBase.construct_base(target=target, mxr=mxr, opcode=_OPCODE, payload=bytes(payload))
511
515
 
512
516
  @staticmethod
@@ -690,13 +694,13 @@ class FrameV2IPDeviceConfiguration(FrameBase):
690
694
  @property
691
695
  def carries_locale(self) -> bool:
692
696
  '''Whether the frame is long enough to say whether it carries a locale.'''
693
- return (self.payload is not None) and (len(self.payload) > _LOCALE_AT)
697
+ return (self.payload is not None) and (len(self.payload) >= _LOCALE_AT + ONEIP_LOCALE_MAX)
694
698
 
695
699
  @cached_property
696
- def locale(self) -> int|None:
697
- '''The locale the frame carries by its number, None when it carries none:
698
- in a frame too short to hold it, or without its bit of the second valid
699
- word.
700
+ def locale(self) -> str|None:
701
+ '''The locale the frame carries by its name, such as NL_NL, None when it
702
+ carries none: in a frame too short to hold the whole name, or without
703
+ its bit of the second valid word. A name may fill its field.
700
704
 
701
705
  From the subject itself, None reports that its firmware has no locales;
702
706
  from another sender it is a write.'''
@@ -706,7 +710,8 @@ class FrameV2IPDeviceConfiguration(FrameBase):
706
710
  valid_ext = struct.unpack_from('<I', p, _VALID_EXT_OFFSET)[0]
707
711
  if not (valid_ext & _SETTING_EXT_LOCALE):
708
712
  return None
709
- return p[_LOCALE_AT]
713
+ name = p[_LOCALE_AT:_LOCALE_AT + ONEIP_LOCALE_MAX].split(b'\0', 1)[0]
714
+ return name.decode('ascii', errors='replace')
710
715
 
711
716
  @cached_property
712
717
  def preview(self) -> str|None: