{"id":13573101,"url":"https://github.com/konnected-io/konnected-security","last_synced_at":"2026-01-16T10:36:09.233Z","repository":{"id":22105476,"uuid":"95272096","full_name":"konnected-io/konnected-security","owner":"konnected-io","description":"Konnected connects wired sensors and switches to SmartThings, Home Assistant, Hubitat and OpenHAB","archived":false,"fork":false,"pushed_at":"2023-03-22T14:20:51.000Z","size":5075,"stargazers_count":418,"open_issues_count":3,"forks_count":323,"subscribers_count":111,"default_branch":"master","last_synced_at":"2024-11-05T07:35:39.214Z","etag":null,"topics":["nodemcu","nodemcu-lua","smartthings"],"latest_commit_sha":null,"homepage":"https://konnected.io","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/konnected-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-06-24T03:01:37.000Z","updated_at":"2024-10-16T11:48:33.000Z","dependencies_parsed_at":"2024-01-16T20:26:04.599Z","dependency_job_id":"97bdfee6-832d-4770-ac7e-a3039e2bbd02","html_url":"https://github.com/konnected-io/konnected-security","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konnected-io%2Fkonnected-security","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konnected-io%2Fkonnected-security/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konnected-io%2Fkonnected-security/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konnected-io%2Fkonnected-security/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/konnected-io","download_url":"https://codeload.github.com/konnected-io/konnected-security/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247170241,"owners_count":20895441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodemcu","nodemcu-lua","smartthings"],"created_at":"2024-08-01T15:00:29.587Z","updated_at":"2026-01-16T10:36:09.164Z","avatar_url":"https://github.com/konnected-io.png","language":"C","funding_links":[],"categories":["C"],"sub_categories":[],"readme":"[![konnected.io](https://raw.githubusercontent.com/konnected-io/docs/master/assets/images/logo-black-small.png)](https://konnected.io)\n\n[![GitHub release](https://img.shields.io/github/release/konnected-io/konnected-security.svg?style=flat-square)](https://github.com/konnected-io/konnected-security/releases)\n\n# Konnected\n\n**Konnected** integrates wired alarm system sensors and sirens to SmartThings, Alexa, Home Assistant, OpenHAB, Hubitat\nusing the [Konnected Alarm Panel](https://konnected.io) or a ESP8266 development board. \n\nThis is open-source software designed to run on the ESP8266 platform only! This is what powers the\n[Konnected Alarm Panel](https://konnected.io) family of ESP8266-based products and is available \nopen-source for you to use on any compatible device.\n\nDevices running this software can connect to local home automation platforms using our\n[2-way realtime REST API](https://help.konnected.io/support/solutions/articles/32000026804-api-overview) or connect to the \n[Konnected Cloud](https://help.konnected.io/support/solutions/articles/32000028756-provision-a-device-in-konnected-cloud),\na cloud service that enables simple integrations with SmartThings or Alexa (currently free to use!).\n\nThis project is built upon the [NodeMCU Lua firmware](https://github.com/nodemcu/nodemcu-firmware).\n\n![alarm-panel-plus-addon-2 3-soona](https://user-images.githubusercontent.com/12016/139100157-5e792dbe-fd08-45c1-8637-7dedfc0ae7ef.jpg)\n\n## Skip this Installation!\n\n[Buy a Konnected Alarm Panel](https://konnected.io), our commercial product that was the inspiration of this open-source\n library. Buying from us is great way to support the developers who have worked hard on this project.\n\n## Getting Started\n\n 1. Flash the device with the latest firmware and filesystem [firmware/releases](firmware/releases) using the instructions in the [Konnected Security Support Documentation](https://help.konnected.io/support/solutions/articles/32000023470-flashing-new-konnected-firmware-software)\n 1. Connect to the WiFi network `konnected-security_XXXXXX` to set up WiFi\n 1. Follow wiring instructions and application setup instructions in the [Konnected Getting Started Guide](https://help.konnected.io/support/solutions/32000015807)\n\n### Device Drivers\n\nWindows and Mac users will need to download drivers so your computer can talk to the ESP8266 chip over USB. Depending\non which board you have, there are different drivers:\n\n**[Silicon Labs USB to UART drivers](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers)** for:\n* all Konnected branded hardware\n* development boards with the name _Amica_ on the back\n* the small component on the board near the USB port is engraved with SiLABS CP2102\n\n**[WeMos CH340 drivers](https://www.wemos.cc/en/latest/ch340_driver.html)** for boards that:\n* have the name _LoLin_ on the back or front\n* the small rectangular component on the board near the USB port is engraved with CH340G\n\n### Download Latest Firmware\n\nGo to the [releases section](https://github.com/konnected-io/konnected-security/releases/latest) for a downloadable image\nthat you can flash on your Konnected Alarm Panel or ESP8266 device.\n\n### Building the Firmware Yourself\nKonnected leverages the [NodeMCU](https://github.com/nodemcu/nodemcu-firmware) codebase to create a base nodeMCU firmware image and a filesystem containing the Konnected application. Building only requires a few steps.\n\n1. Clone the Konnected repo\n\n        git clone https://github.com/konnected-io/konnected-security.git\n\n1. Use the build-firmware script to kick off the build. The build script will automatically pull down the correct nodeMCU image, and use this to create base firmware, an LFS image, and a SPIFFS file system containing the entire Konnected application.\n\n        cd konnected-security\n        ./scripts/build-firmware\n\n1. Once the build completes a folder will be created in `build`. This folder will contain three files reflecting the version or branch.\n   1. konnected-filesystem-0x100000-{BRANCH/VERSION}.img\n   1. konnected-firmware-{BRANCH/VERSION}.bin\n   1. konnected-esp8266-*.bin\n   \nThe `konnected-firmware-*` contains the firmware partition and should be flashed at location `0x0`.\nThe `konnected-filesystem-*` image contains the Konnected application and should be flashed at the memory location in\nthe filename.\nFor convenience, the `konnected-esp8266-latest` image is an all-in-one image to be flashed at memory location `0x0` containing the two images above.\n\n\n### Flashing a Build\nFlashing a build is simple with the [NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher/releases). Simply flash\nthe `konnected-esp8266-latest.bin` file to your device. Typically use baud rate 115200 and flash mode `dio`.\n\nMac and Linux users can also easily flash from the command line using `esptool`\n\n 1. You must have Python installed with `pip` or `pip3`.\n    * **Mac users**: Recommend using [Homebrew](https://brew.sh/) and `brew install python`\n\n 1. Open up a terminal and install `esptool` packages:\n\n        pip3 install esptool\n\n 1. Flash the downloaded image using `esptool`:\n\n         esptool.py --port=/dev/cu.SLAB_USBtoUART write_flash --flash_mode dio --flash_size detect 0x0 konnected-esp8266-latest.bin\n\n *Note: The USB port may vary depending on your computer platform and board.*\n\n\n\n\n### [For more information, click here for Konnected Documentation, Help and Community support](http://help.konnected.io)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonnected-io%2Fkonnected-security","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkonnected-io%2Fkonnected-security","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonnected-io%2Fkonnected-security/lists"}