{"id":15011986,"url":"https://github.com/tidbyt/hdk","last_synced_at":"2025-05-12T15:44:12.888Z","repository":{"id":254902004,"uuid":"665728986","full_name":"tidbyt/hdk","owner":"tidbyt","description":"A community supported firmware for the Tidbyt hardware 🤓","archived":false,"fork":false,"pushed_at":"2024-09-11T15:15:55.000Z","size":3924,"stargazers_count":84,"open_issues_count":7,"forks_count":21,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-31T23:51:05.773Z","etag":null,"topics":["c","firmware","led-matrix-displays","platformio","tidbyt"],"latest_commit_sha":null,"homepage":"https://tidbyt.com","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/tidbyt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"docs/SECURITY.md","support":"docs/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-12T21:38:57.000Z","updated_at":"2025-03-31T00:28:12.000Z","dependencies_parsed_at":"2024-09-15T22:04:03.756Z","dependency_job_id":"fcd34310-2fe3-4d64-91b2-3a473639a0ff","html_url":"https://github.com/tidbyt/hdk","commit_stats":{"total_commits":11,"total_committers":4,"mean_commits":2.75,"dds":0.4545454545454546,"last_synced_commit":"83f884aef0b8e01fc7221806fff65c26d02de37b"},"previous_names":["tidbyt/hdk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbyt%2Fhdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbyt%2Fhdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbyt%2Fhdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbyt%2Fhdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidbyt","download_url":"https://codeload.github.com/tidbyt/hdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253767463,"owners_count":21961113,"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":["c","firmware","led-matrix-displays","platformio","tidbyt"],"created_at":"2024-09-24T19:41:58.900Z","updated_at":"2025-05-12T15:44:12.852Z","avatar_url":"https://github.com/tidbyt.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hardware Development Kit\n[![Docs](https://img.shields.io/badge/docs-tidbyt.dev-blue?style=flat-square)](https://tidbyt.dev)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tidbyt/hdk/main.yaml?style=flat-square)](https://github.com/tidbyt/hdk/actions/workflows/main.yaml)\n[![Discourse](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscuss.tidbyt.com\u0026style=flat-square)](https://discuss.tidbyt.com/)\n[![Discord Server](https://img.shields.io/discord/928484660785336380?style=flat-square)](https://discord.gg/r45MXG4kZc)\n\nThis repository contains a community supported firmware for the Tidbyt hardware 🤓. \n\n![social banner](./docs/assets/social.png)\n\n## Warning\n⚠️ Warning! Flashing your Tidbyt with this firmware or derivatives could fatally \ndamage your device. As such, flashing your Tidbyt with this firmware or\nderivatives voids your warranty and comes without support.\n\n## Setup\nThis project uses PlatformIO to build, flash, and monitor firmware on the Tidbyt.\nTo get started, you will need to download [PlatformIO Core][2] on your computer.\n\nAdditionally, this firmware is designed to work with [Pixlet][1]. Using\n`pixlet serve`, you can serve a WebP on your local network. Take note of your\ncomputers IP address and replace it in the `TIDBYT_REMOTE_URL` example above.\nWhile we had pixlet in mind, you can point this firmware at any URL that hosts\na WebP image that is optimized for the Tidbyt display.\n\n## Getting Started\nTo flash the custom firmware on your device, run the following after replacing\nthe variables with your desired information:\n```\nTIDBYT_WIFI_SSID='Your WiFi' \\\nTIDBYT_WIFI_PASSWORD='super-secret' \\\nTIDBYT_REMOTE_URL='http://192.168.10.10:8080/api/v1/preview.webp' \\\npio run --environment tidbyt --target upload\n```\n\nIf you're flashing to a Tidbyt Gen2, just change to the above to use\nthe `--environment tidbyt-gen2` flag.\n\n## Monitoring Logs\nTo check the output of your running firmware, run the following:\n```\npio device monitor\n```\n\n## Back to Normal\nTo get your Tidbyt back to normal, you can run the following to flash the\nproduction firmware onto your Tidbyt:\n\n```\npio run --target reset --environment tidbyt\n```\n\nAnd if you're working with a Tidbyt Gen 2:\n\n```\npio run --target reset --environment tidbyt-gen2\n```\n\n[1]: https://github.com/tidbyt/pixlet\n[2]: https://docs.platformio.org/en/latest/core/installation/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbyt%2Fhdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidbyt%2Fhdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbyt%2Fhdk/lists"}