A tool for loading firmware onto Dephy devices.
Project description
Dephy Bootloader
This is a tool for loading firmware onto Dephy's devices.
AWS Access
A pre-compiled C library in order to communicate with your device.
These libraries are hosted in a public AWS S3 bucket called dephy-public-binaries
.
Use the show
command to view the available versions (see below).
Additionally, you will need a firmware file (or files) to put on your device. These
files are hosted in a private AWS S3 bucket. You should have received access keys as
a part of your purchase. If you did not, please contact support@dephy.com
.
Once you receive your keys, you'll need to store them in a credentials file to be read
by boto3
(the Python module for interacting with S3).
mkdir ~/.aws
touch ~/.aws/credentials # Note that there is no extension!
Edit the credentials file to contain the following:
[default]
aws_access_key_id=<YOUR ACCES KEY ID HERE>
aws_secret_access_key=<YOUR SECRET ACCESS KEY HERE>
[dephy]
aws_access_key_id=<YOUR ACCES KEY ID HERE>
aws_secret_access_key=<YOUR SECRET ACCESS KEY HERE>
NOTE: If you already have an S3 account, you'll want to put those keys under default
and the Dephy keys under dephy
. If your Dephy access keys are the only ones you have,
you'll want to put the same keys in both sections. boto3
will fail if it does not
find a default
section, but the bootloader explicitly looks for a dephy
section in
case you have other keys.
Installation
It is highly recommended, but not required, that you install bootloader
in a virtual
environment. This helps keep your python and associated packages sandboxed from the
rest of your system and, potentially, other versions of the same packages required by
bootloader
.
You can create a virtual environment via (these commands are for Linux. See the NOTE below for Windows):
mkdir ~/.venvs
python3 -m venv ~/.venvs/dephy
Activate the virtual environment with:
source ~/.venvs/dephy/bin/activate
NOTE: If you're on Windows, the activation command is: source ~/.venvs/dephy/Scripts/activate
.
Additionally, replace python3
with python
.
From PyPI
This is the simplest installation method.
python3 -m pip install dephy-bootloader
From Source
To install from source:
git clone https://github.com/DephyInc/boot-loader.git
cd boot-loader/
git checkout main # Or whichever branch you're interested in
python3 -m pip install .
Drivers
Bootloading one of Dephy's devices requires communicating with the microcontroller called Manage. Manage is a stm32 chip, which means that the stm32 drivers are needed in order for the bootloader to function correctly. The easiest way to install these drivers is to run the installer for the STM32 ST-Link Utility, which can be found here. Once the installation of the STM32 ST-Link Utility finishes, it should prompt you to install the device drivers.
Usage
This package provides the bootload
command-line tool. To see the available commands,
simply run bootload --help
. Additionally, each subcommand has a --help
option
that will give you more information on its usage.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bootloader-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de46c996923383d839a891e8809ebd80a86c957664ff81e40bb260bed86bc137 |
|
MD5 | 1296cfc90f21a5ff7ebe7f40c786777f |
|
BLAKE2b-256 | 9984537ff29f9a44e5af778a3ca80c831e82abbe617788eb447ef017769533e6 |