Send multicast support. (#57)

* Send multicast request method.

Author: Adminiuga

tests/test_application.py

@@ -547,3 +547,40 @@ def test_rx_device_annce(app, ieee, nwk):
     assert app.handle_join.call_args[0][0] == nwk
     assert app.handle_join.call_args[0][1] == ieee
     assert app.handle_join.call_args[0][2] == 0
+
+
+async def _test_mrequest(app, send_success=True, send_timeout=False, **kwargs):
+    seq = 123
+    group_id = 0x2345
+
+    def _mock_command(
+        cmdname, ieee, nwk, src_ep, dst_ep, cluster, profile, radius, options, data
+    ):
+        send_fut = asyncio.Future()
+        if not send_timeout:
+            if send_success:
+                send_fut.set_result(xbee_t.TXStatus.SUCCESS)
+            else:
+                send_fut.set_result(xbee_t.TXStatus.ADDRESS_NOT_FOUND)
+        return send_fut
+
+    app._api._command = mock.MagicMock(side_effect=_mock_command)
+    return await app.mrequest(group_id, 0x0260, 1, 2, seq, b"\xaa\x55\xbe\xef")
+
+
+@pytest.mark.asyncio
+async def test_mrequest_with_reply(app):
+    r = await _test_mrequest(app, send_success=True)
+    assert r[0] == 0
+
+
+@pytest.mark.asyncio
+async def test_mrequest_send_timeout(app):
+    r = await _test_mrequest(app, send_timeout=True)
+    assert r[0] != 0
+
+
+@pytest.mark.asyncio
+async def test_mrequest_send_fail(app):
+    r = await _test_mrequest(app, send_success=False)
+    assert r[0] != 0

zigpy_xbee/zigbee/application.py

@@ -134,6 +134,48 @@ async def _get_association_state(self):
             state = await self._api._at_command("AI")
         return state
 
+    async def mrequest(
+        self,
+        group_id,
+        profile,
+        cluster,
+        src_ep,
+        sequence,
+        data,
+        *,
+        hops=0,
+        non_member_radius=3
+    ):
+        """Submit and send data out as a multicast transmission.
+        :param group_id: destination multicast address
+        :param profile: Zigbee Profile ID to use for outgoing message
+        :param cluster: cluster id where the message is being sent
+        :param src_ep: source endpoint id
+        :param sequence: transaction sequence number of the message
+        :param data: Zigbee message payload
+        :param hops: the message will be delivered to all nodes within this number of
+                     hops of the sender. A value of zero is converted to MAX_HOPS
+        :param non_member_radius: the number of hops that the message will be forwarded
+                                  by devices that are not members of the group. A value
+                                  of 7 or greater is treated as infinite
+        :returns: return a tuple of a status and an error_message. Original requestor
+                  has more context to provide a more meaningful error message
+        """
+        LOGGER.debug("Zigbee request tsn #%s: %s", sequence, binascii.hexlify(data))
+
+        send_req = self._api.tx_explicit(
+            UNKNOWN_IEEE, group_id, src_ep, src_ep, cluster, profile, hops, 0x08, data
+        )
+
+        try:
+            v = await asyncio.wait_for(send_req, timeout=TIMEOUT_TX_STATUS)
+        except asyncio.TimeoutError:
+            return TXStatus.NETWORK_ACK_FAILURE, "Timeout waiting for ACK"
+
+        if v != TXStatus.SUCCESS:
+            return v, "Error sending tsn #%s: %s".format(sequence, v.name)
+        return v, "Successfully sent tsn #%s: %s".format(sequence, v.name)
+
     async def request(
         self,
         device,