linux-bluetooth.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH BlueZ] mesh: Add README file
@ 2019-02-01  0:22 Inga Stotland
  2019-02-04 20:10 ` Gix, Brian
  0 siblings, 1 reply; 2+ messages in thread
From: Inga Stotland @ 2019-02-01  0:22 UTC (permalink / raw)
  To: linux-bluetooth; +Cc: luiz.von.dentz, brian.gix, Inga Stotland

    This file contains instructions for Bluetooth mesh daemon
    configuration and description of the persistent storage.
---
 mesh/README | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 mesh/README

diff --git a/mesh/README b/mesh/README
new file mode 100644
index 000000000..151a1e6a1
--- /dev/null
+++ b/mesh/README
@@ -0,0 +1,50 @@
+Bluetooth Mesh Daemon
+*********************
+
+Copyright (C) 2019  Intel Corporation. All rights reserved.
+
+Compilation and installation
+============================
+
+In addition to main BlueZ requirements, MeshCtl needs the following:
+	- json-c library
+
+Configuration and options
+=========================
+
+	--enable-mesh
+
+		Build mesh daemon and other Bluetooth Mesh based tools
+
+Current implementation of the mesh daemon requires exclusive access to
+a Bluetooth controller.
+The AutoEnable option in the installed main.conf should be set to "false".
+
+Storage
+=======
+
+Default storage directory is /var/lib/bluetooth/mesh.
+
+The directory contains the provisioned nodes configurations.
+Each node has its own subdirectory, named with a 4-digit (hexadecimal)
+identificator that is internally generated by the mesh daemon at the time
+of the node provisioning.
+
+Each subdirectory contains the following files:
+	- node.json:
+		node configuration and is populated by the
+		daemon based on the configuration commands from a
+		provisioner/configuration client
+	- node.json.bak:
+		a backup that the last known good node configuration.
+
+The files are in JSON format.
+
+Information
+===========
+
+Mailing lists:
+	linux-bluetooth@vger.kernel.org
+
+For additional information about the project visit BlueZ web site:
+	http://www.bluez.org
\ No newline at end of file
-- 
2.17.2


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2019-02-04 20:10 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-01  0:22 [PATCH BlueZ] mesh: Add README file Inga Stotland
2019-02-04 20:10 ` Gix, Brian

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).