Giter VIP home page Giter VIP logo

little-inn1 / konnected-security Goto Github PK

View Code? Open in Web Editor NEW

This project forked from konnected-io/konnected-security

0.0 1.0 0.0 3.1 MB

Konnected Security integrates wired alarm system sensors and sirens to SmartThings using a NodeMCU based ESP8266 development board and (optional) relay

Home Page: http://docs.konnected.io/security-alarm-system

License: Apache License 2.0

Groovy 43.26% C 23.80% Shell 0.90% Lua 32.03%

konnected-security's Introduction

konnected.io

GitHub release

Konnected Security

Konnected Security integrates wired alarm system sensors and sirens to SmartThings using a NodeMCU based ESP8266 development board and (optional) relay. This project consists of a few components:

  1. NodeMCU firmware for an ESP8266 development board in firmware
  2. Lua and HTML source code for the NodeMCU in src. All these files should be uploaded to the NodeMCU's internal file system
  3. SmartThings platform code in smartapps and devicetypes

Skip this Installation!

Buy a Konnected Security NodeMCU kit from us and you can skip the installation! We pre-load the Konnected Security software on every NodeMCU device before sending it to you. When you get it, just plug it in connect to WiFi, and it's ready to set up. Buying from us is great way to support the developers who have worked hard on this project.

Installation Overview

  1. Install device drivers for your NodeMCU device.
  2. Flash the device with the included firmware firmware/konnected-firmware-2-0-5.bin
  3. Upload all the code in src to the device and reboot the device.
  4. Connect to the WiFi network konnected-security_XXXXXX to set up WiFi
  5. Follow wiring instructions and SmartThings application setup instructions in the Konnected Security Documentation

Device Drivers

Windows and Mac users will need to download drivers so your computer can talk to the ESP8266 chip over USB. Depending on which board you have, there are different drivers:

WeMos CH340 drivers for boards that:

  • have the name LoLin on the back or front
  • the small rectangular component on the board near the USB port is engraved with CH340G
  • Mac OS X Sierra users: use this driver

Silicon LabsUSB to UART drivers for boards that:

  • have the name Amica on the back
  • the small component on the board near the USB port is engraved with SiLABS CP2102

Mac & Linux Users

  1. You must have Python installed with pip or pip3.

    • Mac users: I recommend using Homebrew and brew install python
  2. Open up a terminal and install esptool packages:

    pip3 install esptool
    
  3. Run the script in scripts/flash to flash the firmware and software to the device. You may need to edit the variables at the top of the script as your serial port may be different depending on your operating system and the type of NodeMCU development board you have. You may also need to make the script executable by running chmod 755 scripts/flash.

Windows Users

  1. Download and install the NodeMCU PyFlasher tool

  2. Using PyFlasher, flash the latest firmware in the firmware directory of this repo at 115200 baud using flash mode dio.

  3. Now you need to upload all the files in the src directory of this repo on to the device. If you're comfortable using Python, I recommend nodemcu-uploader. The command would look something like this:

    C:\Python27\python.exe nodemcu-uploader --port=COM3 upload * --verify=raw

    If you prefer a GUI tool, download and run ESPlorer and connect to your device at baud 115200. Then use the Upload button to upload the files to the device.

Donations

We work hard on this project because we're passionate about making home automation accessible to everybody. Millions of homes in North America and worldwide are already wired with sensors and have the potential to become smart homes. We want to make this a reality.

If you've used Konnected Security and it's improved your life and your home security, please consider donating to help us achieve that goal.

Thank you for your support,

Nate Clark @heythisisnate

konnected-security's People

Contributors

heythisisnate avatar copy-ninja avatar dpaquette avatar naugler avatar emosenkis avatar rdmorin avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.