{"id":38767357,"url":"https://github.com/blues/note-zephyr","last_synced_at":"2026-01-17T12:01:28.996Z","repository":{"id":101585581,"uuid":"474624220","full_name":"blues/note-zephyr","owner":"blues","description":"Zephyr West module \u0026 examples for Notecard","archived":false,"fork":false,"pushed_at":"2025-10-30T16:49:51.000Z","size":106,"stargazers_count":5,"open_issues_count":4,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-12-26T17:50:42.649Z","etag":null,"topics":["notecard","zephyr"],"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/blues.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-27T11:59:44.000Z","updated_at":"2025-10-30T16:29:37.000Z","dependencies_parsed_at":"2024-12-24T12:25:55.111Z","dependency_job_id":"e08f5710-0926-4258-ba29-e07c97c5620c","html_url":"https://github.com/blues/note-zephyr","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/blues/note-zephyr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-zephyr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-zephyr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-zephyr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-zephyr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blues","download_url":"https://codeload.github.com/blues/note-zephyr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnote-zephyr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28508464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T11:50:55.898Z","status":"ssl_error","status_checked_at":"2026-01-17T11:50:55.569Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["notecard","zephyr"],"created_at":"2026-01-17T12:01:18.177Z","updated_at":"2026-01-17T12:01:28.825Z","avatar_url":"https://github.com/blues.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# note-zephyr\n\nThis is a Zephyr `west` module for the Blues Notecard.\nIt is an abstraction layer for the [note-c](https://github.com/blues/note-c) library, that allows you to easily use a [Notecard](https://blues.com/products/notecard/) in a Zephyr application.\n\nIt supports both `I2C` and `UART` communication with the Notecard as well as utilizing Zephyr native APIs for logging and error handling as well as memory management.\n\n## Requirements\n\nWhile this module is designed to be used with the Blues' Feather MCU boards, it can be used with any Zephyr compatible board. Overlays may need to be modified to work with other board device trees.\n\n### Hardware\n\n- Any [Blues Notecard](https://shop.blues.io/collections/notecard)\n- [Blues Notecarrier F](https://shop.blues.com/products/notecarrier-f)\n- Blues Feather MCU boards\n  - [Swan](https://shop.blues.io/products/swan)\n- [STLINK Programmer/Debugger](https://shop.blues.io/collections/accessories/products/stlink-v3mini)\n\n### Software\n\n- [Zephyr SDK](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html) (at least 3.7 LTS)\n- [west](https://docs.zephyrproject.org/latest/guides/west/install.html)\n\n### Cloudware\n\n- [Notehub.io](https://notehub.io)\n\n## Usage\n\nThe easiest way to use this module is to add it to your project as a module using `west`.\nIf you don't have `west` installed, you can install it by following the instructions on the [Zephyr Documentation](https://docs.zephyrproject.org/latest/guides/west/install.html).\n\n### Adding note-zephyr module to your project\n\nTo use this module in your Zephyr project, you will need to add it to your manifest.\nFor example, if you are managing your project with `west`, you can add it to your `west.yml` manifest:\n\n```yaml\nmanifest:\n  projects:\n    - name: zephyr\n      revision: main\n      url: https://github.com/zephyrproject-rtos/zephyr\n      import:\n       name-allowlist:\n          - hal_stm32\n          - cmsis_6\n    - name: note-zephyr\n      path: modules/note-zephyr\n      revision: main\n      submodules: true\n      url: https://github.com/blues/note-zephyr\n    # your other modules here ...\n```\n\n\u003e **Warning:** `submodules: true` is a REQUIRED option for the `note-zephyr` module. This is because the `note-c` library is a submodule and dependency of the `note-zephyr` module.\n\nYou can then run `west update` to fetch the latest changes from the `note-zephyr` module.\n\nYou will also need to enable the module in your `prj.conf` file.\nFor example:\n\n```sh\n# Required by `note-c`\nCONFIG_NEWLIB_LIBC=y\nCONFIG_BLUES_NOTECARD=y\n# Optional: Enable logging\nCONFIG_BLUES_NOTECARD_LOGGING=y\n\n```\n\n\u003e **Note:** The `CONFIG_NEWLIB_LIBC` option is required by `note-c` and must be enabled in your `prj.conf` along with the `CONFIG_BLUES_NOTECARD` option.\n\n## Getting started with examples\n\nTo try the [examples](examples/README.md) standalone, without importing `note-zephyr` as a module, the easiest thing to do is to follow the instructions for [development](#development) below. This will install the dependencies for Blues' Feather MCU boards and allow you to build the examples.\n\nWe're assuming you're using the `swan_r5` board and flashing using an [STLINK](https://shop.blues.io/collections/accessories/products/stlink-v3mini) programmer/debugger.\n\n```sh\n# from the note-zephyr directory\nwest build -b swan_r5 examples/blinky\nwest flash\n```\n\n### Notehub.io\n\nTo see your Notecard data in Notehub, you'll need to set up a free account (no credit card required) on [Notehub.io](https://notehub.io).\nOnce you have created your account, then you need to [create a project](https://dev.blues.io/quickstart/notecard-quickstart/notecard-simulator/#create-a-notehub-project) to serve as an endpoint for the Notes that are tracking the state of the LED.\n\nOnce you have a project, you will need to update the `define` named `PROJECT_UID` in your `main.c` with [the UID of the project you have just created](https://blues.dev/notehub/notehub-walkthrough/#finding-a-productuid).\n\nAfter the Notecard has connected to Notehub, you can look inside the project and see a device named e.g. `zephyr-blink` (for the `blinky` example).\nThe Notecard will be running in `continuous` mode, which will allow it to maintain a constant cellular connection.\n`continuous` mode offers the lowest latency possible for sending messages to Notehub, but it comes at the cost of battery life. Fortunately, this is typically not a concern while bench testing, because you are plugged into USB power.\n\nFor more information about the Notecard API and examples, please visit [our developer site](https://blues.dev).\n\n## Development\n\nTo initialize the repository for development, you can use the following commands:\n\n```sh\nwest init -m https://github.com/blues/note-zephyr --mr main my-workspace\ncd my-workspace\nwest update\n```\n\nThis will create a new workspace (`my-workspace`) with the `note-zephyr` project, ready to build.\n\n### VSCode\n\nYou can also use VSCode with or without a devcontainer to develop with this module.\n`git clone` the repository and open the directory in VSCode.\n\nOpening the directory in VSCode, you should see a popup asking if you want to open the folder in a devcontainer.\nClick `Open in Container`.\n\nYou can then build an example application by opening the command palette and selecting `Zephyr: Build` and specifying the board you want to build for, e.g. `swan_r5`, then the example you want to build, e.g. `examples/blinky`.\n\nSee the [docs](docs/README.md) for more information about the devcontainer.\n\n## Starting a new project\n\nTo start a new project, create a new directory, e.g. `app`, in the root of the repository and add the following files:\n\n```bash\napp\n├── CMakeLists.txt\n├── README.md\n├── prj.conf\n└── src\n    └── main.c\n```\n\nYou may wish to copy across the files from the `examples/blinky` directory to get started.\n\nYou can then build the application by opening the command palette and selecting `Zephyr: Build` and specifying the board you want to build for, e.g. `swan_r5`, then your project directory, e.g. `app`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnote-zephyr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblues%2Fnote-zephyr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnote-zephyr/lists"}