mx-remote 12.0.0__tar.gz → 12.1.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 (293) hide show
  1. {mx_remote-12.0.0 → mx_remote-12.1.0}/PKG-INFO +1 -1
  2. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/api.md +34 -0
  3. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/oneip.md +48 -0
  4. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/Interface.py +117 -0
  5. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/Interface.pyi +48 -0
  6. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/const.py +1 -1
  7. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Constants.py +37 -2
  8. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Constants.pyi +12 -0
  9. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Factory.py +6 -0
  10. mx_remote-12.1.0/mx_remote/proto/FrameMeshConfig.py +184 -0
  11. mx_remote-12.1.0/mx_remote/proto/FrameMeshConfig.pyi +47 -0
  12. mx_remote-12.1.0/mx_remote/proto/FrameMeshReplace.py +178 -0
  13. mx_remote-12.1.0/mx_remote/proto/FrameMeshReplace.pyi +44 -0
  14. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Device.py +11 -1
  15. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Device.pyi +4 -1
  16. mx_remote-12.1.0/mx_remote/remote/Mesh.py +136 -0
  17. mx_remote-12.1.0/mx_remote/remote/Mesh.pyi +24 -0
  18. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Remote.py +212 -5
  19. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Remote.pyi +16 -2
  20. mx_remote-12.1.0/tests/meshmodule.py +408 -0
  21. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/proto_stamp.py +2 -0
  22. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/registry.py +9 -7
  23. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/run.py +1 -0
  24. {mx_remote-12.0.0 → mx_remote-12.1.0}/.gitignore +0 -0
  25. {mx_remote-12.0.0 → mx_remote-12.1.0}/AGENTS.md +0 -0
  26. {mx_remote-12.0.0 → mx_remote-12.1.0}/CLAUDE.md +0 -0
  27. {mx_remote-12.0.0 → mx_remote-12.1.0}/LICENSE +0 -0
  28. {mx_remote-12.0.0 → mx_remote-12.1.0}/README.md +0 -0
  29. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/README.md +0 -0
  30. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/_static/brand.css +0 -0
  31. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/_static/favicon.svg +0 -0
  32. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/_static/logo-dark.svg +0 -0
  33. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/_static/logo.svg +0 -0
  34. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/audio.md +0 -0
  35. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/callbacks.md +0 -0
  36. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/conf.py +0 -0
  37. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/configuration.md +0 -0
  38. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/devices-and-bays.md +0 -0
  39. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/diagnostics.md +0 -0
  40. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/index.md +0 -0
  41. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/multiviewer.md +0 -0
  42. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/requirements.txt +0 -0
  43. {mx_remote-12.0.0 → mx_remote-12.1.0}/docs/routing.md +0 -0
  44. {mx_remote-12.0.0 → mx_remote-12.1.0}/hatch_build.py +0 -0
  45. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/Uid.py +0 -0
  46. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/Uid.pyi +0 -0
  47. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/__init__.py +0 -0
  48. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/__init__.pyi +0 -0
  49. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/compat.py +0 -0
  50. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/compat.pyi +0 -0
  51. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/const.pyi +0 -0
  52. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/deprecated.py +0 -0
  53. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/deprecated.pyi +0 -0
  54. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/main.py +0 -0
  55. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/main.pyi +0 -0
  56. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/BayConfig.py +0 -0
  57. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/BayConfig.pyi +0 -0
  58. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Data.py +0 -0
  59. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Data.pyi +0 -0
  60. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Factory.pyi +0 -0
  61. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAmpDolbySettings.py +0 -0
  62. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAmpDolbySettings.pyi +0 -0
  63. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAmpZoneSettings.py +0 -0
  64. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAmpZoneSettings.pyi +0 -0
  65. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAudioClip.py +0 -0
  66. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAudioClip.pyi +0 -0
  67. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAudioSetRoute.py +0 -0
  68. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameAudioSetRoute.pyi +0 -0
  69. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBase.py +0 -0
  70. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBase.pyi +0 -0
  71. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayConfig.py +0 -0
  72. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayConfig.pyi +0 -0
  73. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayConfigSecondary.py +0 -0
  74. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayConfigSecondary.pyi +0 -0
  75. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayContent.py +0 -0
  76. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayContent.pyi +0 -0
  77. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayHide.py +0 -0
  78. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayHide.pyi +0 -0
  79. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayStatus.py +0 -0
  80. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameBayStatus.pyi +0 -0
  81. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameConnectStatus.py +0 -0
  82. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameConnectStatus.pyi +0 -0
  83. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameDebug.py +0 -0
  84. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameDebug.pyi +0 -0
  85. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameDiscover.py +0 -0
  86. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameDiscover.pyi +0 -0
  87. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameEDID.py +0 -0
  88. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameEDID.pyi +0 -0
  89. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameEDIDProfile.py +0 -0
  90. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameEDIDProfile.pyi +0 -0
  91. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFactoryReset.py +0 -0
  92. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFactoryReset.pyi +0 -0
  93. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFilterStatus.py +0 -0
  94. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFilterStatus.pyi +0 -0
  95. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFirmwareVersion.py +0 -0
  96. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameFirmwareVersion.pyi +0 -0
  97. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameHeader.py +0 -0
  98. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameHeader.pyi +0 -0
  99. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameHello.py +0 -0
  100. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameHello.pyi +0 -0
  101. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameLinks.py +0 -0
  102. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameLinks.pyi +0 -0
  103. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMeshOperation.py +0 -0
  104. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMeshOperation.pyi +0 -0
  105. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMirrorStatus.py +0 -0
  106. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMirrorStatus.pyi +0 -0
  107. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMonitoringPulse.py +0 -0
  108. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameMonitoringPulse.pyi +0 -0
  109. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameNetworkStatus.py +0 -0
  110. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameNetworkStatus.pyi +0 -0
  111. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FramePing.py +0 -0
  112. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FramePing.pyi +0 -0
  113. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FramePowerChange.py +0 -0
  114. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FramePowerChange.pyi +0 -0
  115. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCAction.py +0 -0
  116. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCAction.pyi +0 -0
  117. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCIr.py +0 -0
  118. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCIr.pyi +0 -0
  119. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCKey.py +0 -0
  120. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCKey.pyi +0 -0
  121. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCSettings.py +0 -0
  122. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRCSettings.pyi +0 -0
  123. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameReboot.py +0 -0
  124. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameReboot.pyi +0 -0
  125. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRoutingChange.py +0 -0
  126. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameRoutingChange.pyi +0 -0
  127. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetInstaller.py +0 -0
  128. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetInstaller.pyi +0 -0
  129. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetName.py +0 -0
  130. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetName.pyi +0 -0
  131. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetRoute.py +0 -0
  132. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetRoute.pyi +0 -0
  133. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetupStatus.py +0 -0
  134. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSetupStatus.pyi +0 -0
  135. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSignalStatus.py +0 -0
  136. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSignalStatus.pyi +0 -0
  137. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSignalStatusNew.py +0 -0
  138. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSignalStatusNew.pyi +0 -0
  139. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSysTemperature.py +0 -0
  140. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSysTemperature.pyi +0 -0
  141. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSystemStatus.py +0 -0
  142. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameSystemStatus.pyi +0 -0
  143. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTXRCAction.py +0 -0
  144. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTXRCAction.pyi +0 -0
  145. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTXRCKey.py +0 -0
  146. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTXRCKey.pyi +0 -0
  147. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameThirdParty.py +0 -0
  148. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameThirdParty.pyi +0 -0
  149. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTime.py +0 -0
  150. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTime.pyi +0 -0
  151. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTimeZone.py +0 -0
  152. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTimeZone.pyi +0 -0
  153. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTopology.py +0 -0
  154. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTopology.pyi +0 -0
  155. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTxIR.py +0 -0
  156. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameTxIR.pyi +0 -0
  157. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUnitCommand.py +0 -0
  158. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUnitCommand.pyi +0 -0
  159. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUnitStatus.py +0 -0
  160. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUnitStatus.pyi +0 -0
  161. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUpgradeFPGA.py +0 -0
  162. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameUpgradeFPGA.pyi +0 -0
  163. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPAudio.py +0 -0
  164. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPAudio.pyi +0 -0
  165. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPBayMapping.py +0 -0
  166. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPBayMapping.pyi +0 -0
  167. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPDetectBays.py +0 -0
  168. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPDetectBays.pyi +0 -0
  169. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.py +0 -0
  170. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPDeviceConfiguration.pyi +0 -0
  171. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPLink.py +0 -0
  172. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPLink.pyi +0 -0
  173. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPManualSourceSwitch.py +0 -0
  174. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPManualSourceSwitch.pyi +0 -0
  175. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPMultiviewer.py +0 -0
  176. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPMultiviewer.pyi +0 -0
  177. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPOsdSync.py +0 -0
  178. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPOsdSync.pyi +0 -0
  179. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPPowerSave.py +0 -0
  180. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPPowerSave.pyi +0 -0
  181. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPPrivacy.py +0 -0
  182. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPPrivacy.pyi +0 -0
  183. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSetMaster.py +0 -0
  184. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSetMaster.pyi +0 -0
  185. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSettingsAll.py +0 -0
  186. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSettingsAll.pyi +0 -0
  187. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSinkSdp.py +0 -0
  188. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSinkSdp.pyi +0 -0
  189. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSourceSwitch.py +0 -0
  190. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSourceSwitch.pyi +0 -0
  191. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSources.py +0 -0
  192. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPSources.pyi +0 -0
  193. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPStats.py +0 -0
  194. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPStats.pyi +0 -0
  195. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPTestcard.py +0 -0
  196. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPTestcard.pyi +0 -0
  197. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPTiling.py +0 -0
  198. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPTiling.pyi +0 -0
  199. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPVideoWall.py +0 -0
  200. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameV2IPVideoWall.pyi +0 -0
  201. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolume.py +0 -0
  202. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolume.pyi +0 -0
  203. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeDown.py +0 -0
  204. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeDown.pyi +0 -0
  205. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeSet.py +0 -0
  206. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeSet.pyi +0 -0
  207. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeUp.py +0 -0
  208. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/FrameVolumeUp.pyi +0 -0
  209. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/LinkConfig.py +0 -0
  210. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/LinkConfig.pyi +0 -0
  211. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Multiviewer.py +0 -0
  212. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Multiviewer.pyi +0 -0
  213. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Svd.py +0 -0
  214. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/Svd.pyi +0 -0
  215. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/V2IPConfig.py +0 -0
  216. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/V2IPConfig.pyi +0 -0
  217. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/V2IPStats.py +0 -0
  218. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/V2IPStats.pyi +0 -0
  219. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/__init__.py +0 -0
  220. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/__init__.pyi +0 -0
  221. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/proto/svd.csv +0 -0
  222. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/py.typed +0 -0
  223. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/AudioRoute.py +0 -0
  224. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/AudioRoute.pyi +0 -0
  225. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Bay.py +0 -0
  226. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Bay.pyi +0 -0
  227. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/ConnectionAsync.py +0 -0
  228. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/ConnectionAsync.pyi +0 -0
  229. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Link.py +0 -0
  230. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Link.pyi +0 -0
  231. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/OsdSync.py +0 -0
  232. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/OsdSync.pyi +0 -0
  233. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/State.py +0 -0
  234. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/State.pyi +0 -0
  235. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Tree.py +0 -0
  236. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/Tree.pyi +0 -0
  237. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/V2IP.py +0 -0
  238. {mx_remote-12.0.0 → mx_remote-12.1.0}/mx_remote/remote/V2IP.pyi +0 -0
  239. {mx_remote-12.0.0 → mx_remote-12.1.0}/pyproject.toml +0 -0
  240. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/audio_ir.py +0 -0
  241. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/audiolock.py +0 -0
  242. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/audioroute.py +0 -0
  243. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/baycontent.py +0 -0
  244. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/capture.py +0 -0
  245. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/complete.py +0 -0
  246. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/connect.py +0 -0
  247. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/controllerset.py +0 -0
  248. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/deprecated.py +0 -0
  249. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/downmix.py +0 -0
  250. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/e2e.py +0 -0
  251. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/endpoints.py +0 -0
  252. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/entry.py +0 -0
  253. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/handlers.py +0 -0
  254. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/handlers_cover.py +0 -0
  255. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/hello.py +0 -0
  256. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/idempotent.py +0 -0
  257. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/lengths.py +0 -0
  258. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/merge.py +0 -0
  259. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/mesh.py +0 -0
  260. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/meshbays.py +0 -0
  261. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/meshcontrol.py +0 -0
  262. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/newops.py +0 -0
  263. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/offline.py +0 -0
  264. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/offsets.py +0 -0
  265. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/oneiproute.py +0 -0
  266. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/osdmessage.py +0 -0
  267. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/osdsync.py +0 -0
  268. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/ping.py +0 -0
  269. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/preview.py +0 -0
  270. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/privacy.py +0 -0
  271. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/protogate.py +0 -0
  272. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/rcsettings.py +0 -0
  273. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/roundtrip.py +0 -0
  274. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/routes.py +0 -0
  275. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/smoke.py +0 -0
  276. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/sources.py +0 -0
  277. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/staterequest.py +0 -0
  278. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/stats.py +0 -0
  279. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/structs.py +0 -0
  280. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/thirdparty.py +0 -0
  281. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/txresult.py +0 -0
  282. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/uid.py +0 -0
  283. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/unit.py +0 -0
  284. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/unknowns.py +0 -0
  285. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipptp.py +0 -0
  286. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipscaling.py +0 -0
  287. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipsdp.py +0 -0
  288. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipsettings.py +0 -0
  289. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipsubject.py +0 -0
  290. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2iptestcard.py +0 -0
  291. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/v2ipvlan.py +0 -0
  292. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/vdetails.py +0 -0
  293. {mx_remote-12.0.0 → mx_remote-12.1.0}/tests/wirefix.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: mx_remote
3
- Version: 12.0.0
3
+ Version: 12.1.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/
@@ -409,6 +409,40 @@ The operations a mesh controller sends, and what a controller announces.
409
409
  .. autodata:: mx_remote.proto.FrameV2IPSources.ONEIP_SOURCE_LIST_MAX
410
410
  ```
411
411
 
412
+ ## Mesh replacement and kept settings
413
+
414
+ Replacing an offline unit of a mesh, and the settings each unit keeps for its
415
+ mesh.
416
+
417
+ ```{eval-rst}
418
+ .. autoclass:: mx_remote.MeshReplaceUnit
419
+ :members:
420
+
421
+ .. autoclass:: mx_remote.MeshReplaceUnits
422
+ :members:
423
+
424
+ .. autoclass:: mx_remote.MeshReplaceable
425
+ :members:
426
+
427
+ .. autoclass:: mx_remote.proto.Constants.MeshReplaceResult
428
+ :members:
429
+
430
+ .. autoclass:: mx_remote.MeshSetting
431
+ :members:
432
+
433
+ .. autoclass:: mx_remote.MeshConfigDigest
434
+ :members:
435
+
436
+ .. autoclass:: mx_remote.MeshConfig
437
+ :members:
438
+
439
+ .. autodata:: mx_remote.proto.Constants.MESH_REPLACE_UNITS_MAX
440
+
441
+ .. autodata:: mx_remote.proto.Constants.MESH_REPLACE_NAME_MAX
442
+
443
+ .. autodata:: mx_remote.proto.Constants.MESH_CONFIG_MAX
444
+ ```
445
+
412
446
  ## Names from before OneIP
413
447
 
414
448
  Releases up to 5.11 used the firmware's internal names in the public API: V2IP
@@ -767,6 +767,54 @@ membership report as `mesh_master`. Every other mesh operation a device sends
767
767
  arrives at `MxrCallbacks.on_mesh_operation()`, one this library has no name for
768
768
  with its raw value.
769
769
 
770
+ ### Replacing a unit, and kept settings
771
+
772
+ Units with the mesh module (protocol 0x32 for replacing, 0x33 for kept
773
+ settings) let a unit outside any mesh take the place of an offline one. A
774
+ device without the module answers nothing, and the library sends neither
775
+ opcode to a unit below its version.
776
+
777
+ ```python
778
+ await mx.query_mesh_replaceable() # every device; at most every 2 s
779
+ for r in mx.mesh_replaceable: # listed in the last 30 s, each unit once
780
+ print(r.lister, r.offline_controller, r.unit.uid, r.unit.input_name)
781
+ await mx.request_mesh_replace(lister, r.unit.uid) # answered at on_mesh_replace_answered()
782
+ ```
783
+
784
+ Each controller lists its own offline units, once it has been up 120 s, and a
785
+ member whose controller is offline lists that controller. The device asked
786
+ takes the replacing unit in: the unit's bays, their names and routes, and its
787
+ kept settings. A member asked to replace its offline controller sends this
788
+ client the controller's kept settings instead, and taking over is then this
789
+ client's own: promoting itself to controller and having the members replace
790
+ the old one with `send_mesh_operation()`. A request is refused before sending
791
+ where the device would refuse it: the unit was not listed by that device in the
792
+ last 30 s, this client follows a mesh controller or is on a default serial
793
+ (one starting `P9SN0000` other than `P9SN00000000`), or the unit has a
794
+ `ONEIP_SOURCE`, `ONEIP_SINK` or `MULTIVIEWER` feature this client lacks. As a
795
+ controller this client answers with `send_mesh_replaceable()` and
796
+ `send_mesh_replace_result()`.
797
+
798
+ Every unit in a mesh keeps settings of its own, such as `led.status`, and
799
+ announces their length and crc32 as `device.mesh_config_digest`. The controller
800
+ keeps a copy of every member's, and every member one of its controller's, so a
801
+ replacing unit inherits them:
802
+
803
+ ```python
804
+ await mx.request_mesh_config(holder, subject.remote_id) # holder's copy, or its own
805
+ config = mx.mesh_config(subject.remote_id) # once every frame has arrived
806
+ await mx.send_mesh_config_hello(settings) # this client's own, in a mesh
807
+ await mx.send_mesh_config(to, subject_uid, settings) # the answer to a request
808
+ await mx.send_mesh_config_set(member, settings) # a member takes these, resets the rest
809
+ ```
810
+
811
+ Settings are taken only once every frame has arrived, in order, from one
812
+ sender, and their crc32 matches. A set reaches `on_mesh_config_set_requested()`
813
+ only from the controller this client follows; `send_mesh_config_set()` is
814
+ refused unless the member reports this client as its controller, and a member
815
+ whose settings changed restarts 3 s later. Names and values are at most 255
816
+ bytes with no NUL, and all of them at most `MESH_CONFIG_MAX` (1984) bytes.
817
+
770
818
  ### Time zone and time
771
819
 
772
820
  The mesh controller announces its time zone and clock with every periodic
@@ -2918,6 +2918,78 @@ class MeshControllerReport:
2918
2918
  installer: int
2919
2919
  """The installer id its members take, 0 for none."""
2920
2920
 
2921
+ @dataclass(frozen=True)
2922
+ class MeshReplaceUnit:
2923
+ """A unit a controller can have replaced: it has bays on the controller, it
2924
+ is not the controller, and it is offline."""
2925
+ uid: MxrDeviceUid
2926
+ """The unit."""
2927
+ features: DeviceFeature|int = DeviceFeature(0)
2928
+ """Its features. A unit replacing it must have its ONEIP_SOURCE, ONEIP_SINK
2929
+ and MULTIVIEWER too."""
2930
+ input: int = 0
2931
+ """Its first input bay on the controller, 0 when it has none."""
2932
+ output: int = 0
2933
+ """Its first output bay on the controller, 0 when it has none."""
2934
+ input_name: str = ''
2935
+ """The name of that input, at most MESH_REPLACE_NAME_MAX bytes."""
2936
+ output_name: str = ''
2937
+ """The name of that output, at most MESH_REPLACE_NAME_MAX bytes."""
2938
+
2939
+ @dataclass(frozen=True)
2940
+ class MeshReplaceUnits:
2941
+ """The units one device listed as replaceable."""
2942
+ offline_controller: bool
2943
+ """The units are the sender's own controller, which is offline. A member
2944
+ lists its controller this way; a controller lists its own offline units."""
2945
+ units: tuple[MeshReplaceUnit, ...]
2946
+ """The units, as many of the list as has arrived."""
2947
+ total: int
2948
+ """How many units the whole list holds."""
2949
+
2950
+ @dataclass(frozen=True)
2951
+ class MeshReplaceable:
2952
+ """A unit this client can ask to replace, and who to ask."""
2953
+ lister: MxrDeviceUid
2954
+ """The device that listed it, which a request to replace it goes to."""
2955
+ offline_controller: bool
2956
+ """The unit is the lister's own controller, which is offline."""
2957
+ unit: MeshReplaceUnit
2958
+ """The unit."""
2959
+
2960
+ @dataclass(frozen=True)
2961
+ class MeshSetting:
2962
+ """One setting a unit keeps for its mesh: an application configuration name
2963
+ and its value, each at most 255 bytes. A unit carries only the settings
2964
+ that differ from their default."""
2965
+ name: str
2966
+ """The configuration name, such as led.status."""
2967
+ value: str
2968
+ """The value, as text."""
2969
+
2970
+ @dataclass(frozen=True)
2971
+ class MeshConfigDigest:
2972
+ """The length and crc32 of the settings a unit keeps for its mesh, as the
2973
+ unit announces them: every 60 seconds while it is in a mesh, and shortly
2974
+ after one of them changes."""
2975
+ length: int
2976
+ """The settings' length in bytes, as they are carried."""
2977
+ crc32: int
2978
+ """The crc32 of those bytes."""
2979
+
2980
+ @dataclass(frozen=True)
2981
+ class MeshConfig:
2982
+ """A unit's kept settings, as a device sent them."""
2983
+ subject: MxrDeviceUid
2984
+ """The unit the settings belong to."""
2985
+ holder: MxrDeviceUid
2986
+ """The device that sent them."""
2987
+ copy: bool
2988
+ """They are a copy holder keeps of subject, not its own: the controller
2989
+ keeps one of every member, and a member one of its controller."""
2990
+ settings: tuple[MeshSetting, ...]
2991
+ """The settings, in the order they were sent."""
2992
+
2921
2993
  @dataclass(frozen=True)
2922
2994
  class ThirdPartyMessage:
2923
2995
  """
@@ -3809,6 +3881,12 @@ class DeviceBase(ABC):
3809
3881
  '''What this device last announced about itself as a mesh controller,
3810
3882
  None until it has.'''
3811
3883
 
3884
+ @property
3885
+ @abstractmethod
3886
+ def mesh_config_digest(self) -> MeshConfigDigest|None:
3887
+ '''The length and crc32 of this unit's kept settings, as it last
3888
+ announced them, None until it has.'''
3889
+
3812
3890
  @property
3813
3891
  @abstractmethod
3814
3892
  def is_mesh_master(self) -> bool:
@@ -4914,6 +4992,45 @@ class MxrCallbacks:
4914
4992
  An operation this library has no name for arrives with its raw value. '''
4915
4993
  pass
4916
4994
 
4995
+ def on_mesh_replace_queried(self, dev:DeviceBase) -> None:
4996
+ ''' called when 'dev', a unit outside any mesh, asked which units it can
4997
+ replace. A controller answers with its offline units, and a member
4998
+ whose controller is offline with that controller; see
4999
+ Remote.send_mesh_replaceable(). '''
5000
+ pass
5001
+
5002
+ def on_mesh_replace_units_received(self, dev:DeviceBase, units:MeshReplaceUnits) -> None:
5003
+ ''' called when 'dev' listed units this client can ask it to have
5004
+ replaced: the whole list it has sent so far, which
5005
+ Remote.mesh_replaceable also reads. '''
5006
+ pass
5007
+
5008
+ def on_mesh_replace_requested(self, dev:DeviceBase, unit:MxrDeviceUid) -> None:
5009
+ ''' called when 'dev', a unit outside any mesh, asked to replace 'unit'
5010
+ with it; see Remote.send_mesh_replace_result(). '''
5011
+ pass
5012
+
5013
+ def on_mesh_replace_answered(self, dev:DeviceBase, unit:MxrDeviceUid, result:MeshReplaceResult|int) -> None:
5014
+ ''' called when 'dev' answered this client's request to replace 'unit'.
5015
+ A result this library has no name for arrives as a plain int. '''
5016
+ pass
5017
+
5018
+ def on_mesh_config_requested(self, dev:DeviceBase, subject:MxrDeviceUid) -> None:
5019
+ ''' called when 'dev' asked for the kept settings of 'subject': the
5020
+ addressee's own when it is 'subject', otherwise the copy the addressee
5021
+ keeps; see Remote.send_mesh_config(). '''
5022
+ pass
5023
+
5024
+ def on_mesh_config_received(self, dev:DeviceBase, config:MeshConfig) -> None:
5025
+ ''' called when 'dev' sent a unit's kept settings whole, which
5026
+ Remote.mesh_config() also reads. '''
5027
+ pass
5028
+
5029
+ def on_mesh_config_set_requested(self, dev:DeviceBase, settings:tuple[MeshSetting, ...]) -> None:
5030
+ ''' called when 'dev', the controller this client follows, told it to
5031
+ take these kept settings and reset every other one to its default. '''
5032
+ pass
5033
+
4917
5034
  def on_third_party_message(self, dev:DeviceBase, message:ThirdPartyMessage) -> None:
4918
5035
  ''' called when the application on 'dev' sent a message under its own
4919
5036
  vendor id. A message from a sender this client has not yet heard
@@ -1044,6 +1044,44 @@ class MeshControllerReport:
1044
1044
  priority: int
1045
1045
  installer: int
1046
1046
 
1047
+ @dataclass(frozen=True)
1048
+ class MeshReplaceUnit:
1049
+ uid: MxrDeviceUid
1050
+ features: DeviceFeature | int = ...
1051
+ input: int = ...
1052
+ output: int = ...
1053
+ input_name: str = ...
1054
+ output_name: str = ...
1055
+
1056
+ @dataclass(frozen=True)
1057
+ class MeshReplaceUnits:
1058
+ offline_controller: bool
1059
+ units: tuple[MeshReplaceUnit, ...]
1060
+ total: int
1061
+
1062
+ @dataclass(frozen=True)
1063
+ class MeshReplaceable:
1064
+ lister: MxrDeviceUid
1065
+ offline_controller: bool
1066
+ unit: MeshReplaceUnit
1067
+
1068
+ @dataclass(frozen=True)
1069
+ class MeshSetting:
1070
+ name: str
1071
+ value: str
1072
+
1073
+ @dataclass(frozen=True)
1074
+ class MeshConfigDigest:
1075
+ length: int
1076
+ crc32: int
1077
+
1078
+ @dataclass(frozen=True)
1079
+ class MeshConfig:
1080
+ subject: MxrDeviceUid
1081
+ holder: MxrDeviceUid
1082
+ copy: bool
1083
+ settings: tuple[MeshSetting, ...]
1084
+
1047
1085
  @dataclass(frozen=True)
1048
1086
  class ThirdPartyMessage:
1049
1087
  vendor: ThirdPartyVendor
@@ -1385,6 +1423,9 @@ class DeviceBase(ABC):
1385
1423
  def mesh_controller_report(self) -> MeshControllerReport | None: ...
1386
1424
  @property
1387
1425
  @abstractmethod
1426
+ def mesh_config_digest(self) -> MeshConfigDigest | None: ...
1427
+ @property
1428
+ @abstractmethod
1388
1429
  def is_mesh_master(self) -> bool: ...
1389
1430
  @property
1390
1431
  @abstractmethod
@@ -1819,4 +1860,11 @@ class MxrCallbacks:
1819
1860
  def on_amp_zone_settings_changed(self, bay: BayBase, settings: AmpZoneSettings) -> None: ...
1820
1861
  def on_amp_dolby_settings_changed(self, device: DeviceBase, settings: AmpDolbySettings) -> None: ...
1821
1862
  def on_mesh_operation(self, dev: DeviceBase, operation: MeshOperationMessage) -> None: ...
1863
+ def on_mesh_replace_queried(self, dev: DeviceBase) -> None: ...
1864
+ def on_mesh_replace_units_received(self, dev: DeviceBase, units: MeshReplaceUnits) -> None: ...
1865
+ def on_mesh_replace_requested(self, dev: DeviceBase, unit: MxrDeviceUid) -> None: ...
1866
+ def on_mesh_replace_answered(self, dev: DeviceBase, unit: MxrDeviceUid, result: MeshReplaceResult | int) -> None: ...
1867
+ def on_mesh_config_requested(self, dev: DeviceBase, subject: MxrDeviceUid) -> None: ...
1868
+ def on_mesh_config_received(self, dev: DeviceBase, config: MeshConfig) -> None: ...
1869
+ def on_mesh_config_set_requested(self, dev: DeviceBase, settings: tuple[MeshSetting, ...]) -> None: ...
1822
1870
  def on_third_party_message(self, dev: DeviceBase, message: ThirdPartyMessage) -> None: ...
@@ -14,7 +14,7 @@ Default communication modes:
14
14
  """
15
15
  import os
16
16
 
17
- VERSION = '12.0.0'
17
+ VERSION = '12.1.0'
18
18
  __version__ = VERSION
19
19
 
20
20
  MX_BCAST_UDP_PORT = 8811
@@ -10,7 +10,7 @@
10
10
  from enum import IntEnum, IntFlag
11
11
  from typing import TypeVar
12
12
 
13
- MXR_PROTOCOL_VERSION = 0x30
13
+ MXR_PROTOCOL_VERSION = 0x33
14
14
  """Highest mx_remote protocol version this library understands.
15
15
 
16
16
  Mirrors the firmware's own protocol version. Bump
@@ -32,7 +32,10 @@ every 20-30s once every device it knows is on 0x2A.
32
32
 
33
33
  0x2E is the row of V2IP_SINK_SDP, so an output's session description report
34
34
  arrives stamped 0x2E, 0x2F the row of V2IP_OSD_SYNC and 0x30 the row of
35
- V2IP_PRIVACY."""
35
+ V2IP_PRIVACY.
36
+
37
+ 0x32 and 0x33 are the rows of MESH_REPLACE and MESH_CONFIG, which a unit stamps
38
+ on them, and this client announces the newest stamp it sends."""
36
39
 
37
40
  MXR_PROTOCOL_VERSION_SLOW_HELLO = 0x2A
38
41
  """First protocol version whose devices may hello only every 20-30s."""
@@ -126,6 +129,8 @@ MXR_OPCODE_VERSIONS: dict[int, int] = {
126
129
  # The lowest stamp, so that every receiver's ceiling passes it. No device
127
130
  # decodes the payload, so there is no layout for a stamp to announce.
128
131
  0x55: 0x01, # THIRD_PARTY
132
+ 0x56: 0x32, # MESH_REPLACE (owned by the v2ipmesh module)
133
+ 0x57: 0x33, # MESH_CONFIG (owned by the v2ipmesh module)
129
134
  }
130
135
  """Per-opcode minimum compatible protocol version, mirroring the firmware's
131
136
  own opcode table. Transmitters stamp the
@@ -1318,6 +1323,36 @@ class RCType(IntEnum):
1318
1323
  rv[val.value] = str(val)
1319
1324
  return rv
1320
1325
 
1326
+ class MeshReplaceResult(IntEnum):
1327
+ '''How a controller answered a request to replace one of its units, or how
1328
+ a member answered one to replace its offline controller. A value without a
1329
+ name arrives as a plain int.'''
1330
+ REPLACED = 0
1331
+ '''The unit was replaced with the one that asked.'''
1332
+ REFUSED = 1
1333
+ '''The unit that asked is a member of a mesh, or is on a default serial.'''
1334
+ NOT_FOUND = 2
1335
+ '''The unit named is not one the controller lists as replaceable.'''
1336
+ NOT_CAPABLE = 3
1337
+ '''The unit that asked lacks a OneIP source, OneIP sink or multiviewer
1338
+ feature of the unit named.'''
1339
+ FAILED = 4
1340
+ '''The controller could not replace the unit.'''
1341
+ BUSY = 5
1342
+ '''A membership change of the controller's own has not completed, such as
1343
+ handing the controller role over.'''
1344
+
1345
+ MESH_REPLACE_UNITS_MAX = 32
1346
+ """The most units a controller lists as replaceable, and the most a unit keeps
1347
+ of every controller together."""
1348
+
1349
+ MESH_REPLACE_NAME_MAX = 16
1350
+ """The most bytes of a bay name a replaceable unit's record carries."""
1351
+
1352
+ MESH_CONFIG_MAX = 1984
1353
+ """The most bytes a unit's kept settings take, as they are carried: each setting
1354
+ a byte of name length, the name, a byte of value length and the value."""
1355
+
1321
1356
  class MeshOperation(IntEnum):
1322
1357
  '''What a mesh operation (0x3B) asks of the mesh.'''
1323
1358
  REGISTER = 0
@@ -531,6 +531,18 @@ class RCType(IntEnum):
531
531
  @staticmethod
532
532
  def values() -> dict[int, str]: ...
533
533
 
534
+ class MeshReplaceResult(IntEnum):
535
+ REPLACED: int
536
+ REFUSED: int
537
+ NOT_FOUND: int
538
+ NOT_CAPABLE: int
539
+ FAILED: int
540
+ BUSY: int
541
+
542
+ MESH_REPLACE_UNITS_MAX: int
543
+ MESH_REPLACE_NAME_MAX: int
544
+ MESH_CONFIG_MAX: int
545
+
534
546
  class MeshOperation(IntEnum):
535
547
  REGISTER: int
536
548
  UNREGISTER: int
@@ -252,6 +252,12 @@ def _mxr_frame_factory(hdr:FrameHeader, timestamp:float) -> FrameBase|None:
252
252
  if hdr.opcode == 0x55:
253
253
  from .FrameThirdParty import FrameThirdParty
254
254
  return FrameThirdParty(header=hdr, timestamp=timestamp)
255
+ if hdr.opcode == 0x56:
256
+ from .FrameMeshReplace import FrameMeshReplace
257
+ return FrameMeshReplace(header=hdr, timestamp=timestamp)
258
+ if hdr.opcode == 0x57:
259
+ from .FrameMeshConfig import FrameMeshConfig
260
+ return FrameMeshConfig(header=hdr, timestamp=timestamp)
255
261
  if hdr.opcode == 0x50:
256
262
  from .FrameUnitCommand import FrameUnitCommand
257
263
  return FrameUnitCommand(header=hdr, timestamp=timestamp)
@@ -0,0 +1,184 @@
1
+ ######################################################
2
+ ## MX Remote Python Interface ##
3
+ ## ##
4
+ ## author: Lars Op den Kamp (lars@opdenkamp-it.nl) ##
5
+ ## copyright (c) 2021-2026 Op den Kamp IT Solutions ##
6
+ ######################################################
7
+ '''Protocol frame for MESH_CONFIG (opcode 0x57): the settings each unit keeps
8
+ for its mesh.
9
+
10
+ Every frame opens with a 32-byte header: u8 payload version, u8 kind, u8 flags,
11
+ a reserved byte, u16 offset of this frame's bytes in the settings, u16 length
12
+ of the settings, u32 crc32 of them, four reserved bytes, and at 16 the unit the
13
+ settings belong to. A hello and a request are the header alone; a dump or a set
14
+ carries at most FRAME_MAX bytes of the settings behind it.
15
+
16
+ The settings are carried as pairs: a u8 name length, the name, a u8 value
17
+ length and the value, none terminated.
18
+
19
+ The opcode is served by the v2ipmesh module, so a unit without it answers
20
+ nothing.'''
21
+
22
+ from functools import cached_property
23
+ import struct, zlib
24
+ from typing import Iterable
25
+ from ..compat import override
26
+ from .FrameBase import FrameBase
27
+ from .Constants import MESH_CONFIG_MAX
28
+ from ..Interface import DeviceRegistry, MeshConfigDigest, MeshSetting
29
+ from ..Uid import MxrDeviceUid
30
+
31
+
32
+ VERSION = 1
33
+ '''The payload version every frame opens with; a unit drops any other.'''
34
+ HEADER_SIZE = 32
35
+
36
+ KIND_HELLO = 0
37
+ KIND_REQUEST = 1
38
+ KIND_DUMP = 2
39
+ KIND_SET = 3
40
+
41
+ FLAG_COPY = 1 << 0
42
+ '''The dump flag: the settings are a copy the sender keeps of the unit named,
43
+ not its own.'''
44
+
45
+ FRAME_MAX = 1024
46
+ '''The most settings bytes one frame carries.'''
47
+
48
+ def crc32(data:bytes) -> int:
49
+ '''The crc32 a unit checks its kept settings against: the zlib one.'''
50
+ return zlib.crc32(data) & 0xFFFFFFFF
51
+
52
+ def encode_settings(settings:Iterable[MeshSetting]) -> bytes|None:
53
+ '''Settings as a unit carries them, None for a name or value over 255 bytes
54
+ or holding a NUL, which a unit cannot store, and for settings over
55
+ MESH_CONFIG_MAX bytes, which no unit takes.'''
56
+ p = bytearray()
57
+ for setting in settings:
58
+ for text in (setting.name, setting.value):
59
+ b = text.encode('utf-8')
60
+ if (len(b) > 0xFF) or (b'\0' in b):
61
+ return None
62
+ p += bytes([len(b)]) + b
63
+ return bytes(p) if (len(p) <= MESH_CONFIG_MAX) else None
64
+
65
+ def decode_settings(p:bytes) -> tuple[MeshSetting, ...]|None:
66
+ '''Settings as a unit carries them, None for bytes that end inside a pair. A
67
+ name or value is read as UTF-8, a sequence that is not replaced.'''
68
+ settings:list[MeshSetting] = []
69
+ texts:list[str] = []
70
+ i = 0
71
+ while (i < len(p)):
72
+ n = p[i]
73
+ if (i + 1 + n > len(p)):
74
+ return None
75
+ texts.append(p[i + 1:i + 1 + n].decode('utf-8', errors='replace'))
76
+ i += 1 + n
77
+ if (len(texts) == 2):
78
+ settings.append(MeshSetting(name=texts[0], value=texts[1]))
79
+ texts = []
80
+ return None if texts else tuple(settings)
81
+
82
+ def _header(kind:int, subject:MxrDeviceUid, flags:int=0, offset:int=0, total:int=0, crc:int=0) -> bytes:
83
+ return struct.pack('<BBBxHHI4x', VERSION, kind, flags, offset, total, crc) + subject.byte_value
84
+
85
+ class FrameMeshConfig(FrameBase):
86
+ '''A unit's announcement of its kept settings, a request for a unit's, or
87
+ one frame of them, sent as an answer or to be taken.'''
88
+
89
+ @staticmethod
90
+ def construct_hello(mxr:DeviceRegistry, own:MxrDeviceUid, encoded:bytes) -> FrameBase|None:
91
+ '''A hello to every device: the length and crc32 of the sender's own
92
+ settings, encoded, which name the sender as their unit.'''
93
+ return FrameBase.construct_base(mxr=mxr, opcode=0x57,
94
+ payload=_header(KIND_HELLO, own, total=len(encoded), crc=crc32(encoded)))
95
+
96
+ @staticmethod
97
+ def construct_request(mxr:DeviceRegistry, subject:MxrDeviceUid, to:object=None) -> FrameBase|None:
98
+ '''A request for the settings of subject: the header alone, with no
99
+ offset, length or crc.'''
100
+ return FrameBase.construct_base(mxr=mxr, opcode=0x57, payload=_header(KIND_REQUEST, subject), target=to)
101
+
102
+ @staticmethod
103
+ def construct_pages(mxr:DeviceRegistry, kind:int, flags:int, subject:MxrDeviceUid, encoded:bytes,
104
+ to:object=None) -> list[FrameBase]:
105
+ '''The frames of a dump (KIND_DUMP) or set (KIND_SET), in order: each the
106
+ header, with the offset of its bytes, then at most FRAME_MAX bytes of
107
+ encoded, which comes from encode_settings(). Settings of no bytes are
108
+ one frame.'''
109
+ crc = crc32(encoded)
110
+ frames:list[FrameBase] = []
111
+ for offset in range(0, max(len(encoded), 1), FRAME_MAX):
112
+ p = _header(kind, subject, flags, offset, len(encoded), crc) + encoded[offset:offset + FRAME_MAX]
113
+ if ((frame := FrameBase.construct_base(mxr=mxr, opcode=0x57, payload=p, target=to)) is not None):
114
+ frames.append(frame)
115
+ return frames
116
+
117
+ @cached_property
118
+ def kind(self) -> int|None:
119
+ '''The kind, None for a frame a unit drops: shorter than the header, or
120
+ of a payload version other than VERSION.'''
121
+ p = self.payload or b''
122
+ if (len(p) < HEADER_SIZE) or (p[0] != VERSION):
123
+ return None
124
+ return p[1]
125
+
126
+ @cached_property
127
+ def flags(self) -> int:
128
+ return (self.payload or bytes(HEADER_SIZE))[2]
129
+
130
+ @cached_property
131
+ def offset(self) -> int:
132
+ '''Where this frame's bytes start in the settings.'''
133
+ return struct.unpack_from('<H', self.payload or bytes(HEADER_SIZE), 4)[0]
134
+
135
+ @cached_property
136
+ def total(self) -> int:
137
+ '''The settings' length in bytes.'''
138
+ return struct.unpack_from('<H', self.payload or bytes(HEADER_SIZE), 6)[0]
139
+
140
+ @cached_property
141
+ def crc(self) -> int:
142
+ '''The crc32 of the whole settings.'''
143
+ return struct.unpack_from('<I', self.payload or bytes(HEADER_SIZE), 8)[0]
144
+
145
+ @cached_property
146
+ def subject(self) -> MxrDeviceUid|None:
147
+ '''The unit the settings belong to.'''
148
+ return self.payload_uuid(16) if (self.kind is not None) else None
149
+
150
+ @property
151
+ def chunk(self) -> bytes:
152
+ '''This frame's bytes of the settings.'''
153
+ return bytes((self.payload or b'')[HEADER_SIZE:])
154
+
155
+ @cached_property
156
+ def digest(self) -> MeshConfigDigest|None:
157
+ '''What a hello announces, None for any other kind and for a hello that
158
+ does not name its sender, which a unit ignores.'''
159
+ if (self.kind != KIND_HELLO) or (self.subject != self.remote_id):
160
+ return None
161
+ return MeshConfigDigest(length=self.total, crc32=self.crc)
162
+
163
+ @override
164
+ def process(self) -> None:
165
+ '''Record a hello against its sender, and hand every other kind to the
166
+ registry, which puts settings together and answers.'''
167
+ if (self.kind is None) or ((dev := self.remote_device) is None):
168
+ return
169
+ if ((digest := self.digest) is not None):
170
+ dev.on_mxr_update(digest)
171
+ elif (self.kind != KIND_HELLO):
172
+ self.mxr.on_mxr_update(self)
173
+
174
+ def __str__(self) -> str:
175
+ kind = self.kind
176
+ if (kind == KIND_HELLO):
177
+ return f"mesh config hello: {self.total} bytes, crc32 {self.crc:08x}"
178
+ if (kind == KIND_REQUEST):
179
+ return f"mesh config request for {self.subject}"
180
+ if (kind in (KIND_DUMP, KIND_SET)):
181
+ what = 'dump' if (kind == KIND_DUMP) else 'set'
182
+ return (f"mesh config {what} of {self.subject}: {len(self.chunk)} bytes at {self.offset} "
183
+ f"of {self.total}{' (copy)' if (self.flags & FLAG_COPY) else ''}")
184
+ return "mesh config <dropped>"
@@ -0,0 +1,47 @@
1
+ from ..Interface import DeviceRegistry as DeviceRegistry, MeshConfigDigest as MeshConfigDigest, MeshSetting as MeshSetting
2
+ from ..Uid import MxrDeviceUid as MxrDeviceUid
3
+ from ..compat import override as override
4
+ from .Constants import MESH_CONFIG_MAX as MESH_CONFIG_MAX
5
+ from .FrameBase import FrameBase as FrameBase
6
+ from _typeshed import Incomplete
7
+ from functools import cached_property
8
+ from typing import Iterable
9
+
10
+ VERSION: int
11
+ HEADER_SIZE: int
12
+ KIND_HELLO: int
13
+ KIND_REQUEST: int
14
+ KIND_DUMP: int
15
+ KIND_SET: int
16
+ FLAG_COPY: Incomplete
17
+ FRAME_MAX: int
18
+
19
+ def crc32(data: bytes) -> int: ...
20
+ def encode_settings(settings: Iterable[MeshSetting]) -> bytes | None: ...
21
+ def decode_settings(p: bytes) -> tuple[MeshSetting, ...] | None: ...
22
+
23
+ class FrameMeshConfig(FrameBase):
24
+ @staticmethod
25
+ def construct_hello(mxr: DeviceRegistry, own: MxrDeviceUid, encoded: bytes) -> FrameBase | None: ...
26
+ @staticmethod
27
+ def construct_request(mxr: DeviceRegistry, subject: MxrDeviceUid, to: object = None) -> FrameBase | None: ...
28
+ @staticmethod
29
+ def construct_pages(mxr: DeviceRegistry, kind: int, flags: int, subject: MxrDeviceUid, encoded: bytes, to: object = None) -> list[FrameBase]: ...
30
+ @cached_property
31
+ def kind(self) -> int | None: ...
32
+ @cached_property
33
+ def flags(self) -> int: ...
34
+ @cached_property
35
+ def offset(self) -> int: ...
36
+ @cached_property
37
+ def total(self) -> int: ...
38
+ @cached_property
39
+ def crc(self) -> int: ...
40
+ @cached_property
41
+ def subject(self) -> MxrDeviceUid | None: ...
42
+ @property
43
+ def chunk(self) -> bytes: ...
44
+ @cached_property
45
+ def digest(self) -> MeshConfigDigest | None: ...
46
+ @override
47
+ def process(self) -> None: ...