Skip to main content

Tool built on top of West for managing nRF Connect SDK projects.

Project description

East - tool for building NCS/Zephyr applications

East is a command line meta-tool, useful for creating, managing, and deploying Zephyr or nRF Connect SDK (NCS) projects.

It is built on top of Zephyr's RTOS meta-tool West and Nordic's nRF Connect Toolchain Manager.

Reasoning behind East

There are several reasons why someone would like to create yet another tool on top of west:

  • Working on several projects at once means using different versions of the NCS repository and different versions of the toolchain. Managing these differences is not a trivial task.
  • There is no reproducible build guarantee between the developer's machines. Slight differences between tool versions can manifest into hard-to-find bugs.
  • Creating GitHub releases manually takes ages as you have to run the build process for every combination of the board, application, build variant, etc. and properly rename the release binary. The release procedure gets longer with every addition of new hardware and build variation option.

East automates the above tasks and tries to make the developer more productive.

Key features

  • Automated detection and installation of tooling required for NCS projects.
  • Common west commands used for the development, such as build, flash, etc.
  • Sandboxed development environment, thanks to the nRF Connect Toolchain Manager, every build, flash, etc. command runs inside of its toolchain environment.
  • Automated process of generating release artefacts for your entire project, no matter the number of applications, samples or boards.
  • Support for build types, which is integrated into the usual build process.
  • RTT utility commands to connect and see the RTT stream.

Documentation

docs directory contains several markdown documents about East:

  • Getting stared - Quickly setup an example project and get it building with East.
  • How East works - How East works under the hood and what to expect from it.
  • Configuration - How to configure build types and release procedure via east.yml file.
  • Development guide - How to setup development environment for working on East.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

east_tool-0.24.0.tar.gz (139.9 kB view details)

Uploaded Source

Built Distribution

east_tool-0.24.0-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file east_tool-0.24.0.tar.gz.

File metadata

  • Download URL: east_tool-0.24.0.tar.gz
  • Upload date:
  • Size: 139.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for east_tool-0.24.0.tar.gz
Algorithm Hash digest
SHA256 46204fef5fe58676bccaaa6d6d91f543ecd95a81b0c75b3e2e69799d2bf0177e
MD5 c4ed510834025dded4ba14e3df610846
BLAKE2b-256 668df25eb87772ee326391072a42cb0d8569825797297a47aa7191c1c7ebe87d

See more details on using hashes here.

Provenance

The following attestation bundles were made for east_tool-0.24.0.tar.gz:

Publisher: create-release.yaml on IRNAS/irnas-east-software

Attestations:

File details

Details for the file east_tool-0.24.0-py3-none-any.whl.

File metadata

  • Download URL: east_tool-0.24.0-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for east_tool-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d010f3168eb5f218e5535bd6c20ea30788b173d4642fa9e511bfd54b33cc4d47
MD5 0c3037a5e0722a443194f1a8fd4b6ed9
BLAKE2b-256 50c201a5df55213b2c53d1d0fb5839da5ae99fc3fae23e217444b5bbe689960c

See more details on using hashes here.

Provenance

The following attestation bundles were made for east_tool-0.24.0-py3-none-any.whl:

Publisher: create-release.yaml on IRNAS/irnas-east-software

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page