{"id":34807651,"url":"https://github.com/mehyaa/esp8266-iot-helper","last_synced_at":"2025-12-25T12:05:16.527Z","repository":{"id":56637084,"uuid":"228549846","full_name":"mehyaa/esp8266-iot-helper","owner":"mehyaa","description":"Helper for ESP8266 that orchestrates WiFi connection and OTA updates","archived":false,"fork":false,"pushed_at":"2019-12-17T08:43:19.000Z","size":7,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-02T18:41:40.026Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mehyaa.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}},"created_at":"2019-12-17T06:37:05.000Z","updated_at":"2023-02-25T07:54:25.000Z","dependencies_parsed_at":"2022-08-15T22:20:40.811Z","dependency_job_id":null,"html_url":"https://github.com/mehyaa/esp8266-iot-helper","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/mehyaa/esp8266-iot-helper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehyaa%2Fesp8266-iot-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehyaa%2Fesp8266-iot-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehyaa%2Fesp8266-iot-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehyaa%2Fesp8266-iot-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mehyaa","download_url":"https://codeload.github.com/mehyaa/esp8266-iot-helper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mehyaa%2Fesp8266-iot-helper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28028885,"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","status":"online","status_checked_at":"2025-12-25T02:00:05.988Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-12-25T12:04:47.512Z","updated_at":"2025-12-25T12:05:16.499Z","avatar_url":"https://github.com/mehyaa.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESP8266 IoT Helper\n\nThis library contains a simple helper that you can orchestrate WiFi connection via SmartConfig and Arduino IDE + HTTP OTA update features all together.\n\n## How to use\n\nInstantiate **helper** with valid HTTP OTA information:\n\n`ESP8266IoTHelper iotHelper(\"\u003cHTTP OTA Server Host\u003e\", \u003cHTTP OTA Server Port\u003e, \"\u003cHTTP OTA Server Path\u003e\")`\n\nor with only SmartConfig and Arduino IDE OTA updates capability:\n\n`ESP8266IoTHelper iotHelper`\n\nThen in your setup function `initialize` it:\n\n`iotHelper.initialize()`\n\nAnd on your loop function call `execute` (preferably the first line):\n\n`iotHelper.execute()`\n\n## What does it do\n\n### Initialize\n\n* Tries to connect WiFi with your previosly saved WiFi configuration. If can not connect WiFi, starts SmartConfig.\n\n* Sets up Arduino IDE OTA and HTTP OTA updates and checks for OTA updates if valid configuration supported.\n\n### Execute\n\n* Checks if the SmartConfig input pin is active (HIGH or LOW as your config) if enabled by configuration and if pin is active then starts SmartConfig.\n\n* Checks if Arduino IDE OTA updates available.\n\n* Checks HTTP OTA updates if valid configuration supported.\n\n## Functions\n\n**`iotHelper.initialize`:** Initialize the WiFi connection and OTA features.\n\n**`iotHelper.execute`:** Check SmartConfig trigger and OTA updates.\n\n**`iotHelper.wifiConnectionTimeout`:** Set or get timeout in seconds for WiFi connection.\n\n**`iotHelper.smartConfigTimeout`:**  Set or get timeout in seconds for SmartConfig.\n\n**`iotHelper.smartConfigTriggerEnabled`:** Set or get SmartConfig trigger enabled. Must be set before `initialize`.\n\n**`iotHelper.smartConfigTriggerPin`:** Set or get SmartConfig trigger pin. Must be set before `initialize`.\n\n**`iotHelper.smartConfigTriggerPinMode`:** Set or get SmartConfig trigger pin mode. Must be set before `initialize`.\n\n**`iotHelper.smartConfigTriggerPinPullup`:** Set or get SmartConfig trigger is pull up or not. Must be set before `initialize`.\n\n**`iotHelper.httpOtaEnabled`:** Set or get HTTP OTA updates enabled.\n\n**`iotHelper.httpOtaHost`:** Set or get server host name or IP address for HTTP OTA updates.\n\n**`iotHelper.httpOtaPort`:** Set or get server port for HTTP OTA updates.\n\n**`iotHelper.httpOtaPath`:** Set or get server path for HTTP OTA updates.\n\n**`iotHelper.httpOtaCheckPeriod`:** Set or get HTTP OTA updates check period in milliseconds.\n\n**`iotHelper.lastHttpOtaCheckTime`:** Get last HTTP OTA updates checked time.\n\n**`iotHelper.rebootOnUpdate`:** Set if reboot on HTTP OTA updates.\n\n**`iotHelper.followRedirects`:** Get if follow HTTP redirects on HTTP OTA updates.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehyaa%2Fesp8266-iot-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmehyaa%2Fesp8266-iot-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmehyaa%2Fesp8266-iot-helper/lists"}