{"id":13396940,"url":"https://github.com/adafruit/circuitpython","last_synced_at":"2025-10-01T05:30:53.745Z","repository":{"id":37251528,"uuid":"66166069","full_name":"adafruit/circuitpython","owner":"adafruit","description":"CircuitPython - a Python implementation for teaching coding with microcontrollers","archived":false,"fork":true,"pushed_at":"2025-09-24T18:11:20.000Z","size":224939,"stargazers_count":4341,"open_issues_count":823,"forks_count":1331,"subscribers_count":133,"default_branch":"main","last_synced_at":"2025-09-24T19:09:46.904Z","etag":null,"topics":["beginner","circuitpython","cpython","education","embedded","hacktoberfest","microcontroller","micropython","python","python3"],"latest_commit_sha":null,"homepage":"https://circuitpython.org","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"micropython/micropython","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adafruit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-08-20T20:10:40.000Z","updated_at":"2025-09-24T18:11:28.000Z","dependencies_parsed_at":"2023-09-24T18:16:23.057Z","dependency_job_id":null,"html_url":"https://github.com/adafruit/circuitpython","commit_stats":{"total_commits":24645,"total_committers":913,"mean_commits":26.9934282584885,"dds":0.7757760194765673,"last_synced_commit":"9c1d83476ebe76c70e409e64a57de3b81e924b49"},"previous_names":[],"tags_count":332,"template":false,"template_full_name":null,"purl":"pkg:github/adafruit/circuitpython","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2Fcircuitpython","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2Fcircuitpython/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2Fcircuitpython/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2Fcircuitpython/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/circuitpython/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2Fcircuitpython/sbom","scorecard":{"id":164548,"data":{"date":"2025-08-11","repo":{"name":"github.com/adafruit/circuitpython","commit":"117b5d1ed9bab67f91f852777bf4cec8ee8b53e4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.5,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 21 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build-board-custom.yml:1","Warn: no topLevel permission defined: .github/workflows/build-boards.yml:1","Warn: no topLevel permission defined: .github/workflows/build-mpy-cross.yml:1","Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/create-website-pr.yml:1","Warn: no topLevel permission defined: .github/workflows/notify-on-issue-label.yml:1","Warn: no topLevel permission defined: .github/workflows/pre-commit.yml:1","Warn: no topLevel permission defined: .github/workflows/run-tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":0,"reason":"29 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-3ww4-gg4f-jr7f","Warn: Project is vulnerable to: GHSA-9v9h-cgj8-h64p","Warn: Project is vulnerable to: PYSEC-2021-62 / GHSA-hggm-jpg3-v476","Warn: Project is vulnerable to: PYSEC-2017-8 / GHSA-q3cj-2r34-2cwc","Warn: Project is vulnerable to: PYSEC-2019-217 / GHSA-462w-v97r-4m45","Warn: Project is vulnerable to: PYSEC-2014-8 / GHSA-8r7q-cvjq-x353","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: PYSEC-2014-82 / GHSA-fqh9-2qgg-h84h","Warn: Project is vulnerable to: PYSEC-2021-66 / GHSA-g3rq-g295-4j3m","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: PYSEC-2019-220 / GHSA-hj2j-77xm-mc5v","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: PYSEC-2018-49 / GHSA-rprw-h62v-c2w7","Warn: Project is vulnerable to: PYSEC-2014-14 / GHSA-652x-xj99-gmcc","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2014-13 / GHSA-cfj3-7x9c-4p3h","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg","Warn: Project is vulnerable to: PYSEC-2013-22 / GHSA-27x4-j476-jp5f","Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: PYSEC-2022-43012 / GHSA-r9hx-vwmv-q579","Warn: Project is vulnerable to: PYSEC-2021-95 / GHSA-8ch4-58qp-g3mp","Warn: Project is vulnerable to: PYSEC-2018-79","Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6","Warn: Project is vulnerable to: GHSA-xgfm-fjx6-62mj","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Binary-Artifacts","score":7,"reason":"binaries present in source code","details":["Warn: binary detected: ports/atmel-samd/libs/libgcc-14.2.0-Os-v6-m-nofp.a:1","Warn: binary detected: ports/atmel-samd/tools/bossac_linux:1","Warn: binary detected: ports/atmel-samd/tools/bossac_osx:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Info: Possibly incomplete results: error parsing shell code: invalid parameter name: .github/workflows/run-tests.yml:50","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-board-custom.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-board-custom.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-board-custom.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-board-custom.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-boards.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-boards.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-boards.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-boards.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-boards.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-boards.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-mpy-cross.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-mpy-cross.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-mpy-cross.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-mpy-cross.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-mpy-cross.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build-mpy-cross.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:174: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:181: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:195: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:201: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:208: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:248: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:278: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:313: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:319: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:117: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:142: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:149: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-website-pr.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/create-website-pr.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-website-pr.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/create-website-pr.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/notify-on-issue-label.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/notify-on-issue-label.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/pre-commit.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/pre-commit.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/pre-commit.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/pre-commit.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/run-tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/adafruit/circuitpython/run-tests.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .devcontainer/common_tools.sh:43","Warn: pipCommand not pinned by hash: .devcontainer/common_tools.sh:44","Warn: pipCommand not pinned by hash: .devcontainer/esp-idf-toolchain.sh:29","Warn: pipCommand not pinned by hash: .devcontainer/esp-idf-toolchain.sh:30","Warn: pipCommand not pinned by hash: tools/ci.sh:121","Warn: pipCommand not pinned by hash: tools/ci.sh:176","Warn: pipCommand not pinned by hash: tools/ci.sh:177","Warn: pipCommand not pinned by hash: tools/ci.sh:211","Warn: npmCommand not pinned by hash: tools/ci.sh:237","Warn: pipCommand not pinned by hash: tools/ci.sh:306","Warn: pipCommand not pinned by hash: tools/ci.sh:307","Warn: pipCommand not pinned by hash: tools/ci.sh:315","Warn: pipCommand not pinned by hash: tools/ci.sh:316","Warn: pipCommand not pinned by hash: tools/ci.sh:407","Warn: pipCommand not pinned by hash: tools/ci.sh:408","Warn: pipCommand not pinned by hash: tools/ci.sh:409","Warn: pipCommand not pinned by hash: tools/ci.sh:594","Warn: pipCommand not pinned by hash: tools/ci.sh:595","Warn: pipCommand not pinned by hash: tools/ci.sh:596","Warn: pipCommand not pinned by hash: tools/ci.sh:643","Warn: pipCommand not pinned by hash: tools/ci.sh:644","Warn: pipCommand not pinned by hash: tools/ci.sh:645","Warn: pipCommand not pinned by hash: tools/test-stubs.sh:5","Warn: pipCommand not pinned by hash: tools/test-stubs.sh:9","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:192","Info:   0 out of  30 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned","Info:   0 out of  24 pipCommand dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-16T14:26:51.358Z","repository_id":37251528,"created_at":"2025-08-16T14:26:51.358Z","updated_at":"2025-08-16T14:26:51.358Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277650348,"owners_count":25853846,"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-09-30T02:00:09.208Z","response_time":75,"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":["beginner","circuitpython","cpython","education","embedded","hacktoberfest","microcontroller","micropython","python","python3"],"created_at":"2024-07-30T18:01:08.167Z","updated_at":"2025-10-01T05:30:53.739Z","avatar_url":"https://github.com/adafruit.png","language":"C","readme":"CircuitPython\n=============\n\n.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png\n\n|Build Status| |Doc Status| |License| |Discord| |Weblate|\n\n`circuitpython.org \u003chttps://circuitpython.org\u003e`__ \\| `Get CircuitPython \u003c#get-circuitpython\u003e`__ \\|\n`Documentation \u003c#documentation\u003e`__ \\| `Contributing \u003c#contributing\u003e`__ \\|\n`Branding \u003c#branding\u003e`__ \\| `Differences from Micropython \u003c#differences-from-micropython\u003e`__ \\|\n`Project Structure \u003c#project-structure\u003e`__\n\n**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive\ncomputers called microcontrollers. Microcontrollers are the brains of many electronics including a\nwide variety of development boards used to build hobby projects and prototypes. CircuitPython in\nelectronics is one of the best ways to learn to code because it connects code to reality. Simply\ninstall CircuitPython on a supported USB board usually via drag and drop and then edit a ``code.py``\nfile on the CIRCUITPY drive. The code will automatically reload. No software installs are needed\nbesides a text editor (we recommend `Mu \u003chttps://codewith.mu/\u003e`_ for beginners.)\n\nStarting with CircuitPython 7.0.0, some boards may only be connectable over Bluetooth Low Energy\n(BLE). Those boards provide serial and file access over BLE instead of USB using open protocols.\n(Some boards may use both USB and BLE.) BLE access can be done from a variety of apps including\n`code.circuitpython.org \u003chttps://code.circuitpython.org\u003e`_.\n\nCircuitPython features unified Python core APIs and a growing list of 300+ device libraries and\ndrivers that work with it. These libraries also work on single board computers with regular\nPython via the `Adafruit Blinka Library \u003chttps://github.com/adafruit/Adafruit_Blinka\u003e`_.\n\nCircuitPython is based on `MicroPython \u003chttps://micropython.org\u003e`_. See\n`below \u003c#differences-from-micropython\u003e`_ for differences. Most, but not all, CircuitPython\ndevelopment is sponsored by `Adafruit \u003chttps://adafruit.com\u003e`_ and is available on their educational\ndevelopment boards. Please support both MicroPython and Adafruit.\n\nGet CircuitPython\n------------------\n\nOfficial binaries for all supported boards are available through\n`circuitpython.org/downloads \u003chttps://circuitpython.org/downloads\u003e`_. The site includes stable, unstable and\ncontinuous builds. Full release notes are available through\n`GitHub releases \u003chttps://github.com/adafruit/circuitpython/releases\u003e`_ as well.\n\nDocumentation\n-------------\n\nGuides and videos are available through the `Adafruit Learning\nSystem \u003chttps://learn.adafruit.com/\u003e`__ under the `CircuitPython\ncategory \u003chttps://learn.adafruit.com/category/circuitpython\u003e`__. An API\nreference is also available on `Read the Docs\n\u003chttp://circuitpython.readthedocs.io/en/latest/?\u003e`__. A collection of awesome\nresources can be found at `Awesome CircuitPython \u003chttps://github.com/adafruit/awesome-circuitpython\u003e`__.\n\nSpecifically useful documentation when starting out:\n\n- `Welcome to CircuitPython \u003chttps://learn.adafruit.com/welcome-to-circuitpython\u003e`__\n- `CircuitPython Essentials \u003chttps://learn.adafruit.com/circuitpython-essentials\u003e`__\n- `Example Code \u003chttps://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/CircuitPython_Essentials\u003e`__\n\nContributing\n------------\n\nSee\n`CONTRIBUTING.md \u003chttps://github.com/adafruit/circuitpython/blob/main/CONTRIBUTING.md\u003e`__\nfor full guidelines but please be aware that by contributing to this\nproject you are agreeing to the `Code of\nConduct \u003chttps://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md\u003e`__.\nContributors who follow the `Code of\nConduct \u003chttps://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md\u003e`__\nare welcome to submit pull requests and they will be promptly reviewed\nby project admins. Please join the\n`Discord \u003chttps://adafru.it/discord\u003e`__ too.\n\nBranding\n------------\n\nWhile we are happy to see CircuitPython forked and modified, we'd appreciate it if forked releases\nnot use the name \"CircuitPython\" or the Blinka logo. \"CircuitPython\" means something special to\nus and those who learn about it. As a result, we'd like to make sure products referring to it meet a\ncommon set of requirements.\n\nIf you'd like to use the term \"CircuitPython\" and Blinka for your product here is what we ask:\n\n- Your product is supported by the primary\n  `\"adafruit/circuitpython\" \u003chttps://github.com/adafruit/circuitpython\u003e`_ repo. This way we can\n  update any custom code as we update the CircuitPython internals.\n- Your product is listed on `circuitpython.org \u003chttps://circuitpython.org\u003e`__ (source\n  `here \u003chttps://github.com/adafruit/circuitpython-org/\u003e`_). This is to ensure that a user of your\n  product can always download the latest version of CircuitPython from the standard place.\n- Your product supports at least one standard \"`Workflow \u003chttps://docs.circuitpython.org/en/latest/docs/workflows.html\u003e`__\" for serial and file access:\n\n  - With a user accessible USB plug which appears as a CIRCUITPY drive when plugged in.\n  - With file and serial access over Bluetooth Low Energy using the BLE Workflow.\n  - With file access over WiFi using the WiFi Workflow with serial access over USB and/or WebSocket.\n\n- Boards that do not support the USB Workflow should be clearly marked.\n\nIf you choose not to meet these requirements, then we ask you call your version of CircuitPython\nsomething else (for example, SuperDuperPython) and not use the Blinka logo. You can say it is\n\"CircuitPython-compatible\" if most CircuitPython drivers will work with it.\n\n--------------\n\nDifferences from `MicroPython \u003chttps://github.com/micropython/micropython\u003e`__\n-----------------------------------------------------------------------------\n\nCircuitPython:\n\n-  Supports native USB on most boards and BLE otherwise, allowing file editing without special tools.\n-  Floats (aka decimals) are enabled for all builds.\n-  Error messages are translated into 10+ languages.\n-  Concurrency within Python is not well supported. Interrupts and threading are disabled.\n   async/await keywords are available on some boards for cooperative multitasking. Some concurrency\n   is achieved with native modules for tasks that require it such as audio file playback.\n\nBehavior\n~~~~~~~~\n\n-  The order that files are run and the state that is shared between\n   them. CircuitPython's goal is to clarify the role of each file and\n   make each file independent from each other.\n\n   -  ``boot.py`` runs only once on start up before\n      workflows are initialized. This lays the ground work for configuring USB at\n      startup rather than it being fixed. Since serial is not available,\n      output is written to ``boot_out.txt``.\n   -  ``code.py`` (or ``main.py``) is run after every reload until it\n      finishes or is interrupted. After it is done running, the vm and\n      hardware is reinitialized. **This means you cannot read state from**\n      ``code.py`` **in the REPL anymore, as the REPL is a fresh vm.** CircuitPython's goal for this\n      change includes reducing confusion about pins and memory being used.\n   -  After the main code is finished the REPL can be entered by pressing any key.\n      - If the file ``repl.py`` exists, it is executed before the REPL Prompt is shown\n      - In safe mode this functionality is disabled, to ensure the REPL Prompt can always be reached\n   -  Autoreload state will be maintained across reload.\n\n-  Adds a safe mode that does not run user code after a hard crash or brown out. This makes it\n   possible to fix code that causes nasty crashes by making it available through mass storage after\n   the crash. A reset (the button) is needed after it's fixed to get back into normal mode.\n-  A 1 second delay is added to the boot process during which time the status LED will flash, and\n   resetting the device or pressing the boot button will force the device into safe mode. This delay\n   can be removed by a compile time option (``CIRCUITPY_SKIP_SAFE_MODE_WAIT``).\n-  Safe mode may be handled programmatically by providing a ``safemode.py``.\n   ``safemode.py`` is run if the board has reset due to entering safe mode, unless the safe mode\n   initiated by the user by pressing button(s).\n   USB is not available so nothing can be printed.\n   ``safemode.py`` can determine why the safe mode occurred\n   using ``supervisor.runtime.safe_mode_reason``, and take appropriate action. For instance,\n   if a hard crash occurred, ``safemode.py`` may do a ``microcontroller.reset()``\n   to automatically restart despite the crash.\n   If the battery is low, but is being charged, ``safemode.py`` may put the board in deep sleep\n   for a while. Or it may simply reset, and have ``code.py`` check the voltage and do the sleep.\n-  RGB status LED indicating CircuitPython state.\n   - One green flash - code completed without error.\n   - Two red flashes - code ended due to an exception.\n   - Three yellow flashes - safe mode. May be due to CircuitPython internal error.\n-  Re-runs ``code.py`` or other main file after file system writes by a workflow. (Disable with\n   ``supervisor.disable_autoreload()``)\n-  Autoreload is disabled while the REPL is active.\n-  ``code.py`` may also be named ``code.txt``, ``main.py``, or ``main.txt``.\n-  ``boot.py`` may also be named ``boot.txt``.\n-  ``safemode.py`` may also be named ``safemode.txt``.\n\nAPI\n~~~\n\n-  Unified hardware APIs. Documented on\n   `ReadTheDocs \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html\u003e`_.\n-  API docs are Python stubs within the C files in ``shared-bindings``.\n-  No ``machine`` API.\n\nModules\n~~~~~~~\n\n-  No module aliasing. (``uos`` and ``utime`` are not available as\n   ``os`` and ``time`` respectively.) Instead ``os``, ``time``, and\n   ``random`` are CPython compatible.\n-  New ``storage`` module which manages file system mounts.\n   (Functionality from ``uos`` in MicroPython.)\n-  Modules with a CPython counterpart, such as ``time``, ``os`` and\n   ``random``, are strict\n   `subsets \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html\u003e`__\n   of their `CPython\n   version \u003chttps://docs.python.org/3.4/library/time.html?highlight=time#module-time\u003e`__.\n   Therefore, code from CircuitPython is runnable on CPython but not\n   necessarily the reverse.\n-  tick count is available as\n   `time.monotonic() \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic\u003e`__\n\n--------------\n\nProject Structure\n-----------------\n\nHere is an overview of the top-level source code directories.\n\nCore\n~~~~\n\nThe core code of\n`MicroPython \u003chttps://github.com/micropython/micropython\u003e`__ is shared\namongst ports including CircuitPython:\n\n-  ``docs`` High level user documentation in Sphinx reStructuredText\n   format.\n-  ``drivers`` External device drivers written in Python.\n-  ``examples`` A few example Python scripts.\n-  ``extmod`` Shared C code used in multiple ports' modules.\n-  ``lib`` Shared core C code including externally developed libraries\n   such as FATFS.\n-  ``logo`` The CircuitPython logo.\n-  ``mpy-cross`` A cross compiler that converts Python files to byte\n   code prior to being run in MicroPython. Useful for reducing library\n   size.\n-  ``py`` Core Python implementation, including compiler, runtime, and\n   core library.\n-  ``shared-bindings`` Shared definition of Python modules, their docs\n   and backing C APIs. Ports must implement the C API to support the\n   corresponding module.\n-  ``shared-module`` Shared implementation of Python modules that may be\n   based on ``common-hal``.\n-  ``tests`` Test framework and test scripts.\n-  ``tools`` Various tools, including the pyboard.py module.\n\nPorts\n~~~~~\n\nPorts include the code unique to a microcontroller line.\n\nThe following ports are available: ``atmel-samd``, ``cxd56``, ``espressif``, ``litex``, ``mimxrt10xx``, ``nordic``, ``raspberrypi``, ``renode``, ``silabs`` (``efr32``), ``stm``, ``unix``.\n\nHowever, not all ports are fully functional. Some have limited functionality and known serious bugs.\nFor details, refer to the **Port status** section in the `latest release \u003chttps://github.com/adafruit/circuitpython/releases/latest\u003e`__ notes.\n\nBoards\n~~~~~~\n\n-  Each ``port`` has a ``boards`` directory containing boards\n   which belong to a specific microcontroller line.\n-  A list of native modules supported by a particular board can be found\n   `here \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html\u003e`__.\n\n`Back to Top \u003c#circuitpython\u003e`__\n\n.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg\n   :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain\n.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest\n   :target: http://circuitpython.readthedocs.io/\n.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg\n   :target: https://adafru.it/discord\n.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg\n   :target: https://choosealicense.com/licenses/mit/\n.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg\n   :target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget\n","funding_links":[],"categories":["C","Lightweight implementations","Forks","Code","硬件_其他","Code Frameworks"],"sub_categories":["Educational","网络服务_其他","CircuitPython"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fcircuitpython","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2Fcircuitpython","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fcircuitpython/lists"}