diff options
| author | Inga Stotland <inga.stotland@intel.com> | 2019-11-01 11:57:29 -0700 |
|---|---|---|
| committer | Brian Gix <brian.gix@intel.com> | 2019-11-04 14:54:38 -0800 |
| commit | 29c1ed83bc0f47c9545261a3a8bd284af902febe (patch) | |
| tree | 0ee5ac6b0a197d715677ccdd592145bc1ca22812 | |
| parent | 5c6e6e5524909220fa5879b8928b35d6cdb3f08a (diff) | |
| download | bluez-29c1ed83bc0f47c9545261a3a8bd284af902febe.tar.gz | |
tools/mesh-cfgclient: Add README file
| -rw-r--r-- | tools/mesh/README | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/tools/mesh/README b/tools/mesh/README new file mode 100644 index 000000000..9362d8ff6 --- /dev/null +++ b/tools/mesh/README @@ -0,0 +1,54 @@ +MeshCfgclient - BlueZ PB-Adv based Bluetooth Mesh Provisioner +************************************************************* + +Copyright (C) 2019 Intel Corporation. All rights reserved. + +Compilation and installation +============================ + +In addition to main BlueZ requirements, MeshCfgclient needs the following: + - JSON library + +Configuration and options +========================= + + --enable-mesh + + Build mesh-cfgclient and other Bluetooth Mesh based tools + +Storage for mesh configuration file +=================================== + +The mesh-cfgclient tool generates a mesh configuration file in JSON format: + - mesh_db.json +that contains information about the current state of the configured mesh +network. + +The default directory for mesh-cfgclient configuration file is +/home/<username>/.config/mesh-cfgcli + +To specify a custom storage directory, run mesh-config tool as: + + meshctl -c <config_dir_name> + +If a configuration file is not found, it is assumed that a mesh network +does not exist. In this case, the tool may be used to generate a new mesh +network by invoking "create" command from the main menu and, on a successful +completion of this command, an initial configuration file is written. + +If the configuration file is present, then "create" command will fail. This +is done so that the existing configuration is not accidentally overwritten. +If the intention is to create a new network then, the existing mesh +configuration file has to be either moved or dleted prior to running the +mesh-cfgclient tool. Also, a new custom storage location may be +specified for a new network on the start up as a command line option. + + +Information +=========== + +Mailing lists: + linux-bluetooth@vger.kernel.org + +For additional information about the project visit BlueZ web site: + http://www.bluez.org |