From 8673fa27e2f16238e993a22096f4592287899daf Mon Sep 17 00:00:00 2001
From: Koen Kanters <koenkanters94@gmail.com>
Date: Tue, 24 Apr 2018 18:04:36 +0200
Subject: [PATCH] Improve naming of configuration

---
 data/configuration.yaml | 5 +++--
 lib/controller.js       | 4 ++--
 lib/zigbee.js           | 8 ++++----
 support/docgen.js       | 2 +-
 4 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/data/configuration.yaml b/data/configuration.yaml
index 3dcb80bd2..a7446f9e9 100644
--- a/data/configuration.yaml
+++ b/data/configuration.yaml
@@ -1,10 +1,11 @@
 default:
-  allowJoin: true  
-  homeassistant_discovery: false
+  permit_join: true  
+  homeassistant: false
   mqtt:
     server: "mqtt://localhost"
     base_topic: zigbee2mqtt
   serial:
     port: /dev/ttyACM0
+
 user:
   devices: {}
diff --git a/lib/controller.js b/lib/controller.js
index 62ddb7a36..73f3f60cc 100644
--- a/lib/controller.js
+++ b/lib/controller.js
@@ -25,7 +25,7 @@ class Controller {
             } else {
                 this.mqtt.connect(this.handleMQTTMessage, () => {
                     // Home assistant MQTT discovery on startup.
-                    if (settings.get().homeassistant_discovery) {
+                    if (settings.get().homeassistant) {
                         const devices = this.zigbee.getAllClients();
 
                         devices.forEach((device) => {
@@ -96,7 +96,7 @@ class Controller {
         }
 
         // Home assistant MQTT discovery
-        if (settings.get().homeassistant_discovery && mappedModel.homeassistant && 
+        if (settings.get().homeassistant && mappedModel.homeassistant && 
             !this.hassDiscoveryCache[device.ieeeAddr]) {
             this.homeassistantDiscover(mappedModel, device, friendlyName);
             this.hassDiscoveryCache[device.ieeeAddr] = true;
diff --git a/lib/zigbee.js b/lib/zigbee.js
index 541290ff5..179e8c1d6 100644
--- a/lib/zigbee.js
+++ b/lib/zigbee.js
@@ -64,13 +64,13 @@ class Zigbee {
         });
 
         // Allow or disallow new devices to join the network.
-        if (settings.get().allowJoin) {
-            logger.warn('allowJoin set to  true in configuration.yaml.')
+        if (settings.get().permit_join) {
+            logger.warn('`permit_join` set to  `true` in configuration.yaml.')
             logger.warn('Allowing new devices to join.');
-            logger.warn('Remove this parameter once you joined all devices.');
+            logger.warn('Set `permit_join` to `false` once you joined all devices.');
         }
 
-        this.shepherd.permitJoin(settings.get().allowJoin ? 255 : 0, (error) => {
+        this.shepherd.permitJoin(settings.get().permit_join ? 255 : 0, (error) => {
             if (error) {
                 logger.info(error);
             }
diff --git a/support/docgen.js b/support/docgen.js
index eac1a0838..36589cce8 100644
--- a/support/docgen.js
+++ b/support/docgen.js
@@ -57,7 +57,7 @@ fs.writeFileSync(outputdir + '/' + file, text);
 file = 'Integrating-with-home-assistant.io.md';
 text = '*NOTE: Automatically generated by `npm run docgen`*\n\n';
 text += 'The easiest way to integrate zigbee2mqtt with home assistant is by using [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/).'
-text += ' To enable MQTT discovery set `homeassistant_discovery: true` in your zigbee2mqtt `configuration.yaml` and add the following to your home assistant `configuration.yaml`.\n'
+text += ' To enable MQTT discovery set `homeassistant: true` in your zigbee2mqtt `configuration.yaml` and add the following to your home assistant `configuration.yaml`.\n'
 text += '```yaml\n'
 text += 'mqtt:\n'
 text += '  discovery: true\n'