{"id":48789330,"url":"https://github.com/markis/inkplate10-dashboard","last_synced_at":"2026-04-13T19:02:46.508Z","repository":{"id":346195049,"uuid":"1188627878","full_name":"markis/inkplate10-dashboard","owner":"markis","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-22T18:05:47.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-23T09:15:22.801Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-22T11:07:24.000Z","updated_at":"2026-03-22T18:05:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/markis/inkplate10-dashboard","commit_stats":null,"previous_names":["markis/inkplate10-dashboard"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/markis/inkplate10-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Finkplate10-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Finkplate10-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Finkplate10-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Finkplate10-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markis","download_url":"https://codeload.github.com/markis/inkplate10-dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Finkplate10-dashboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31766482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T15:25:13.801Z","status":"ssl_error","status_checked_at":"2026-04-13T15:25:09.162Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2026-04-13T19:02:43.096Z","updated_at":"2026-04-13T19:02:46.496Z","avatar_url":"https://github.com/markis.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inkplate 10 Dashboard\n\nESP32-based e-ink dashboard that downloads and displays an image from a URL, then sends telemetry via MQTT.\n\n## Setup\n\n### 1. Clone and Install Dependencies\n\n```bash\ngit clone \u003cyour-repo-url\u003e\ncd ink-dashboard\npio lib install\n```\n\n### 2. Configure Private Settings\n\nCopy the example config file and edit with your credentials:\n\n```bash\ncp src/config.h.example src/config.h\n```\n\nEdit `src/config.h` with your settings:\n- WiFi SSID and password\n- MQTT broker address and credentials\n- Image URL\n\n**Important:** `src/config.h` is gitignored to keep your credentials private. Never commit this file!\n\n### 3. Build and Upload\n\n```bash\n# Build the project\npio run\n\n# Upload to device\npio run -t upload\n\n# Monitor serial output\npio device monitor --baud 115200\n```\n\n## Features\n\n- **Image Display**: Downloads JPEG images via HTTPS and displays them on the e-ink screen\n- **Nighttime Sleep**: Automatically sleeps for 6 hours (midnight to 6 AM) to save power\n- **Smart NTP Sync**: Synchronizes time from NTP server only every 24 hours to conserve battery\n- **Timezone Support**: Full POSIX timezone configuration with automatic DST adjustment\n- **Error Handling**: Preserves last image on WiFi/network failures, retries with shorter sleep intervals\n- **MQTT Telemetry**: Reports temperature and battery voltage\n- **Smart Sleep Scheduling**: Adaptive sleep duration based on time of day\n- **E-ink Friendly**: Only updates display when new image successfully downloads\n\n## Configuration\n\nAll private configuration is in `src/config.h`:\n\n| Setting | Description |\n|---------|-------------|\n| `WIFI_SSID` | Your WiFi network name |\n| `WIFI_PASSWORD` | Your WiFi password |\n| `MQTT_SERVER` | MQTT broker IP address |\n| `MQTT_PORT` | MQTT broker port (default: 1883) |\n| `MQTT_CLIENT_ID` | MQTT client identifier (default: Inkplate) |\n| `MQTT_USER` | MQTT username |\n| `MQTT_PASSWORD` | MQTT password |\n| `MQTT_TOPIC` | MQTT topic for telemetry |\n| `IMAGE_URL` | URL of the image to display |\n| `NTP_SERVER` | NTP server address (default: pool.ntp.org) |\n| `TIMEZONE` | POSIX timezone string (e.g., \"EST5EDT,M3.2.0/2,M11.1.0/2\" for Eastern Time with DST) |\n\nPublic constants in `main.cpp`:\n- `NORMAL_SLEEP_S`: 1200s (20 minutes) - normal operation\n- `ERROR_SLEEP_S`: 300s (5 minutes) - on failures\n- `NIGHT_SLEEP_S`: 21600s (6 hours) - midnight to 6 AM\n- `NIGHT_START_HOUR`: 0 (midnight, 24-hour format)\n- `NIGHT_END_HOUR`: 6 (6 AM, 24-hour format)\n- `WIFI_TIMEOUT_MS`: 20000ms (20 seconds)\n- `IMAGE_RETRY_ATTEMPTS`: 2\n- `NTP_SYNC_INTERVAL_S`: 86400s (24 hours) - NTP resync interval\n\n## Hardware\n\n- **Board**: Inkplate 10 (ESP32-based e-paper display)\n- **Display**: 9.7\" e-ink, 1200x825 pixels\n- **Platform**: PlatformIO + ESP32 + Arduino framework\n- **CR2032 Battery**: Required for RTC time persistence between deep sleep cycles\n\n## Dependencies\n\n- InkplateLibrary @ 10.2.1\n- PubSubClient @ 2.8.0\n- NTPClient @ 3.2.1\n- ESP32Time @ 2.0.6\n- Timezone @ 1.2.4\n\n## Nighttime Sleep Feature\n\nSee [NIGHTTIME_SLEEP.md](docs/NIGHTTIME_SLEEP.md) for detailed information about the nighttime sleep scheduling feature, including:\n- How time synchronization works\n- Timezone configuration examples\n- Power savings calculations\n- Troubleshooting guide\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkis%2Finkplate10-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkis%2Finkplate10-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkis%2Finkplate10-dashboard/lists"}