Linux-Bluetooth Archive on lore.kernel.org
 help / color / Atom feed
From: Inga Stotland <inga.stotland@intel.com>
To: linux-bluetooth@vger.kernel.org
Cc: luiz.von.dentz@intel.com, brian.gix@intel.com,
	Inga Stotland <inga.stotland@intel.com>
Subject: [PATCH BlueZ] mesh: Add README file
Date: Thu, 31 Jan 2019 16:22:41 -0800
Message-ID: <20190201002241.19170-1-inga.stotland@intel.com> (raw)

    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


             reply index

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-01  0:22 Inga Stotland [this message]
2019-02-04 20:10 ` Gix, Brian

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190201002241.19170-1-inga.stotland@intel.com \
    --to=inga.stotland@intel.com \
    --cc=brian.gix@intel.com \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=luiz.von.dentz@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-Bluetooth Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-bluetooth/0 linux-bluetooth/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-bluetooth linux-bluetooth/ https://lore.kernel.org/linux-bluetooth \
		linux-bluetooth@vger.kernel.org linux-bluetooth@archiver.kernel.org
	public-inbox-index linux-bluetooth


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-bluetooth


AGPL code for this site: git clone https://public-inbox.org/ public-inbox