Adds two new MGMT Commands:
- MESH_MODE - Enable Mesh Mode with either Active or Passive
scanning for a list of AD Types (Mesh and/or Extended Mesh).
- MESH_SEND - Send a requested Mesh Packet on a non-resolvable
random address, perhaps with a specific fine-timed delay.
Adds one new MGMT Event:
- MESH_DEVICE_FOUND - Returned when Mesh is enabled, and one of
the requested AD Types is detected in an incoming
Advertisement.
Signed-off-by: Brian Gix <brian.gix@xxxxxxxxx>
---
doc/mgmt-api.txt | 119 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 119 insertions(+)
diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index ebe56afa4..3c34d6fb9 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -332,6 +332,7 @@ Read Controller Information Command
15 Static Address
16 PHY Configuration
17 Wideband Speech
+ 18 Mesh Mode
This command generates a Command Complete event on success or
a Command Status event on failure.
@@ -3858,6 +3859,90 @@ Add Advertisement Patterns Monitor With RSSI Threshold Command
Invalid Parameters
+Set controller to Mesh mode Command
+==============================================================
+
+ Command Code: 0x0057
+ Controller Index: <controller id>
+ Command Parameters: Enable (1 Octet)
+ Active (1 Octet)
+ AD Types { }
+ Return Parameters: Available Slots (1 Octet)
+
+ This command Enables or Disables Mesh Mode. Mesh mode, when enabled
+ keeps the controller passivly or actively scanning for LE Advertising
+ messgaes. To enable Mesh, LE must be enabled.
+
+ The Active parameter when set to 0x01, will cause the controller to
+ perform active scanning, as opposed to passive scanning, when the
+ parameter is set to 0x00.
+
+ The AD Types parameter, if present, will filter Advertising and Scan
+ responses by AD type. reponses that do not contain at least one of the
+ requested AD types will be discarded. response results will be delivered
+ with the Mesh Device Found event.
+
+ This command may be called redundantly to switch between Active and
+ Passive scanning, without disabling Mesh mode. If Mesh mode is disabled,
+ all active outbound Mesh Packet Send requests will return fail codes.
+
+ The returned parameter Available Slots returns the number of
+ simultaneous outbound packets that may to queued for delivery.
+
+ Possible errors: Failed
+ Busy
+ No Resources
+ Invalid Parameters
+
+
+Mesh Packet Send Command
+==============================================================
+
+ Command Code: 0x0058
+ Controller Index: <controller id>
+ Command Parameters: Reference (1 Octets)
+ Instant (4 Octets)
+ Delay (2 Octets)
+ Count (1 Octets)
+ Data { }
+ Return Parameters: Status, Reference Value
+
+ This command sends a Mesh Packet as a NONCONN LE Advertisement. Mesh
+ mode must be enabled.
+
+ The Reference value is Host defined, and will be returned with the
+ status, so that the Host may have multiple requests outstanding at
+ the same time. The Reference value will not be interpretted by the
+ kernel.
+
+ The Instant parameter is used in combination with the Delay
+ parameter, to finely time the sending of the Advertising packet. It
+ should be set to the Instant value tag of a received incoming
+ Mesh Device Found Event. It is only useful in POLL-RESPONSE situations
+ where a response must be sent within a negotiated time window. The value
+ of the Instant parameter should not be interpreted by the host, and
+ only has meaning to the controller.
+
+ The Delay parameter, if 0x0000, will cause the packet to be sent
+ immediately, or at the earliest opportunity. If non-Zero, it will
+ attempt to send the packet the requested number of milliseconds after
+ the instant in time represented by the Instant parameter.
+
+ The Count parameter must be sent to a non-Zero value indicating the
+ number of times this packet will be sent before transmission completes.
+ If the Delay parameter is non-Zero, then Count must be 1 only.
+
+ The Data parameter is an octet array of the AD Type and Mesh Packet.
+
+ This command will return only after the outbound packet has been sent,
+ or it fails.
+
+ Possible errors: Failed
+ Busy
+ No Resources
+ Invalid Parameters
+
+
Command Complete Event
======================
@@ -4978,3 +5063,37 @@ Advertisement Monitor Device Lost Event
2 LE Random
This event will be sent to all management sockets.
+
+Mesh Device Found Event
+========================================
+
+ Event code: 0x0031
+ Controller Index: <controller_id>
+ Event Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ RSSI (1 Octet)
+ Flags (4 Octets)
+ Instant (4 Octets)
+ AD_Data_Length (2 Octets)
+ AD_Data (0-65535 Octets)
+
+ This event indicates that the controller has received an Advertisement
+ or Scan Result containing an AD Type matching the Mesh scan set.
+
+ The address of the sending device is returned, and must be a valid LE
+ Address_Type.
+
+ Possible values for the Address_Type parameter:
+ 0 Reserved (not in use)
+ 1 LE Public
+ 2 LE Random
+
+ The RSSI field is a signed octet, and is the RSSI reported by the
+ receiving controller.
+
+ The Instant field is 32 bit value that represents the instant in time
+ the packet was received. It's value is not intended to be interpretted
+ by the host, and is only useful if the host wants to make a timed
+ response to the received packet. (i.e. a Poll/Response)
+
+ This event will be sent to all management sockets.
--
2.31.1
