{"id":162,"date":"2017-05-10T20:47:20","date_gmt":"2017-05-10T20:47:20","guid":{"rendered":"http:\/\/www.cribbstechnologies.com\/?page_id=162"},"modified":"2017-05-13T15:29:10","modified_gmt":"2017-05-13T15:29:10","slug":"doorbell-software","status":"publish","type":"page","link":"https:\/\/www.cribbstechnologies.com\/index.php\/home-automation\/mqtt-integrated-doorbell\/doorbell-software\/","title":{"rendered":"Doorbell – Software"},"content":{"rendered":"

[et_pb_section bb_built=”1″ admin_label=”Section” fullwidth=”on” specialty=”off” background_image=”http:\/\/www.cribbstechnologies.com\/wp-content\/uploads\/2017\/05\/doorbellHeader.jpg” transparent_background=”off” allow_player_pause=”off” inner_shadow=”off” parallax=”off” parallax_method=”on” make_fullwidth=”off” use_custom_width=”off” width_unit=”on” make_equal=”off” use_custom_gutter=”off”][et_pb_fullwidth_header admin_label=”Fullwidth Header” title=”MQTT Integrated Doorbell” background_layout=”light” text_orientation=”left” header_fullscreen=”off” header_scroll_down=”off” parallax=”off” parallax_method=”off” content_orientation=”center” image_orientation=”center” disabled=”off” disabled_on=”on||” custom_button_one=”off” button_one_letter_spacing=”0″ button_one_use_icon=”default” button_one_icon_placement=”right” button_one_on_hover=”on” button_one_letter_spacing_hover=”0″ custom_button_two=”off” button_two_letter_spacing=”0″ button_two_use_icon=”default” button_two_icon_placement=”right” button_two_on_hover=”on” button_two_letter_spacing_hover=”0″ custom_css_main_element=”height: 544px” custom_css_title=”margin-top: 95px;||font-size: 36px;” saved_tabs=”all” \/][\/et_pb_section][et_pb_section bb_built=”1″ admin_label=”section”][et_pb_row admin_label=”row”][et_pb_column type=”3_4″][et_pb_text admin_label=”Text” background_layout=”light” text_orientation=”left” use_border_color=”off” border_color=”#ffffff” border_style=”solid”]<\/p>\n

Software<\/h1>\n

My requirements for this project were that it must:<\/p>\n

    \n
  1. Integrate with my current doorbell with minimal changes<\/li>\n
  2. Allow me to disable the bell when I choose<\/li>\n
  3. Notify subscribers whenever the doorbell button was pressed<\/li>\n<\/ol>\n

    The hardware<\/a> portion of this project already covered how I accomplished #1. Because the voltage path to the doorbell solenoid runs through a microcontroller-controlled relay, #2 is easily accomplished. The code subscribes itself to a MQTT topic to allow it to read messages to enable or disable the relay control. This message is published to the queue as a persistent message so it will survive restarts of the device. The code also publishes non-persistent messages to a MQTT queue when the button is pressed.<\/p>\n

    [\/et_pb_text][et_pb_text admin_label=”Embedded code” background_layout=”light” text_orientation=”left” use_border_color=”off” border_color=”#ffffff” border_style=”solid”]<\/p>\n

    Embedded code<\/h2>\n
    \n#include <ESP8266WiFi.h>\n#include <PubSubClient.h>\n\n\/\/ Update these with values suitable for your network.\nconst char* ssid = "";\nconst char* password = "";\nconst char* mqtt_server = "";\nconst char* mqtt_user = "";\nconst char* mqtt_password = "";\n\nconst int SWITCH_INPUT = D1;\nconst int BELL_OUTPUT = D2;\n\nconst char* IDENTIFIER = "doorbell";\nconst char* STATUS_TOPIC = "doorbell\/status";\nconst char* COMMAND_TOPIC = "doorbell\/command";\nconst char* RING_TOPIC = "doorbell\/ring";\n\nconst char* DISABLE_COMMAND = "DISABLE";\nconst char* ENABLE_COMMAND = "ENABLE";\nconst char* RING_COMMAND = "RING";\n\nint debounceTimeout = 2000;\nbool disableRing = false;\nlong lastTrigger;\n\nWiFiClient espClient;\nPubSubClient client(espClient);\n\nvoid setup_wifi() {\n   delay(100);\n  \/\/ We start by connecting to a WiFi network\n    Serial.print("Connecting to ");\n    Serial.println(ssid);\n    WiFi.begin(ssid, password);\n    while (WiFi.status() != WL_CONNECTED) {\n      delay(500);\n      Serial.print(".");\n    }\n  randomSeed(micros());\n  Serial.println("");\n  Serial.println("WiFi connected");\n  Serial.println("IP address: ");\n  Serial.println(WiFi.localIP());\n}\n\nvoid callback(char* topic, byte* payload, unsigned int length) {\n  Serial.print("Received: ");\n  Serial.println((char *)payload);\n  Serial.print("Command with length: ");\n  Serial.print(length);\n  Serial.print(" from MQTT broker is : [");\n  Serial.print(topic);\n  Serial.print("] value: ");\n  String value = "";\n  for(int i=0;i<length;i++) {\n    value = value +  (char)payload[i];    \n  }\n  Serial.println(value);\n  if (value != "") {\n    if (strcmp(topic, COMMAND_TOPIC) == 0) {\n      Serial.println(value);\n      if (value == DISABLE_COMMAND) {\n        Serial.println("They wanna disable");\n        disableRing = true;\n        client.publish(STATUS_TOPIC, DISABLE_COMMAND, true);\n      } else if (value == ENABLE_COMMAND) {\n        Serial.println("They wanna enable");\n        disableRing = false;\n        client.publish(STATUS_TOPIC, ENABLE_COMMAND, true);\n      } else if (value == RING_COMMAND) {\n        Serial.println("They wanna ring");\n        youCanRingMyBeeeeeeeell(false);\n      }\n    }\n  }\n}\/\/end callback\n\nvoid reconnect() {\n  \/\/ Loop until we're reconnected\n  while (!client.connected()) {\n    Serial.print("Attempting MQTT connection...");\n    \/\/ Create a random client ID\n    String clientId = "ESP8266Doorbell-";\n    clientId += String(random(0xffff), HEX);\n    \/\/ Attempt to connect\n    if (client.connect(clientId.c_str(), mqtt_user, mqtt_password)) {\n      Serial.println("connected");\n     \/\/once connected to MQTT broker, subscribe command if any\n      client.subscribe(COMMAND_TOPIC);\n    } else {\n      Serial.print("failed, rc=");\n      Serial.print(client.state());\n      Serial.println(" try again in 5 seconds");\n      \/\/ Wait 6 seconds before retrying\n      delay(6000);\n    }\n  }\n} \/\/end reconnect()\n\nvoid setup() {\n  Serial.begin(115200);\n  lastTrigger = millis();\n  setup_wifi();\n  client.setServer(mqtt_server, 1883);\n  client.setCallback(callback);\n  pinMode(SWITCH_INPUT, INPUT);\n  pinMode(BELL_OUTPUT, OUTPUT);\n  digitalWrite(BELL_OUTPUT, LOW);\n}\n\nvoid youCanRingMyBeeeeeeeell(bool fromButton) {\n  if (fromButton) {\n      client.publish(RING_TOPIC, "RING", false);\n    }\n  if (!disableRing) {\n    digitalWrite(BELL_OUTPUT,HIGH);\n    delay(400);\n    digitalWrite(BELL_OUTPUT,LOW);\n  }\n}\n\nvoid loop() {\n  if (!client.connected()) {\n    reconnect();\n  }\n  client.loop();\n  \n  int pinVal = digitalRead(SWITCH_INPUT);\n  if (pinVal == HIGH) {\n    if (millis() - lastTrigger >= debounceTimeout) {\n      lastTrigger = millis();\n      youCanRingMyBeeeeeeeell(true);\n    }\n    \n  }\n}\n<\/code><\/pre>\n
    [\/et_pb_text][et_pb_text admin_label=”Text” background_layout=”light” text_orientation=”left” use_border_color=”off” border_color=”#ffffff” border_style=”solid”]<\/p>\n
    Home Assistant Configuration<\/h2>\n
    Home Assistant needs to be configured so it can enable and disable the doorbell ring.<\/p>\n
    \n- platform: mqtt\n  name: "Doorbell Ring"\n  command_topic: "doorbell\/command"\n  payload_on: "ENABLE"\n  payload_off: "DISABLE"\n  state_topic: "doorbell\/status"\n  optimistic: false\n  retain: false\n<\/code><\/pre>\n
    After configuration and a restart you should see the switch in your dashboard now.<\/p>\n
    \"\"<\/p>\n
    It can also be used to set up automations when the doorbell rings<\/p>\n
    \nalias: Doorbell Rung\ninitial_state: True\ntrigger:\n  platform: mqtt\n  topic: doorbell\/ring\ncondition:\n  condition: state\n  entity_id: switch.doorbell_ring\n  state: 'off'\naction:\n  service: tts.google_say\n  data_template:\n    entity_id: media_player.downstairs_home\n    message: "There's someone at the door!"\n<\/code><\/pre>\n
    [\/et_pb_text][\/et_pb_column][et_pb_column type=”1_4″][et_pb_code admin_label=”Code”]
    \n\t\t\t