You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
xgm220p-tex/README

58 lines
2.5 KiB
Plaintext

xgm220p-tex
A low-power wireless prototyping module designed deep in the heart of Texas
FEATURES
- Silicon Labs xGM220P Wireless Gecko Module
- 2x10 100mil-pitch through-hole footprint for a straight or angled, front
or back-mounted header/socket
- Mini Simplicity and Tag-Connect debug connectors
- SOIC/WSON-8 SPI flash
- Texas Instruments TPS22917 load switch to control SPI peripheral power
LICENSE
This work is licensed under the terms of the Creative Commons
Attribution-NonCommercial-NoDerivatives 4.0 International License.
To view or obtain a copy of this license, visit
https://creativecommons.org/licenses/by-nc-nd/4.0/ or send a letter to
Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
DEPENDENCIES
- KiCad version 5.1.9 for macOS. Results with previous or subsequent
versions will likely vary.
- kipy (https://git.alt-tek.com/nathan/dots/src/branch/main/macos/bin/kipy)
is useful to simplify executing scripts with KiCad's Python environment.
It is required to generate board plots with plot.py for releases.
Because the Python included with KiCad for macOS also tries to dynamically
load system libraries which don't always exist, kipy also sets the
DYLD_FALLBACK_LIBRARY_PATH environment variable such that MacPorts
libraries can supplement where needed. Notably, installing the MacPorts
OpenSSL package can eliminate many 'unsupported hash type' errors.
- tea (https://gitea.com/gitea/tea) is required to generate releases.
Install and write your API token to ~/.config/git.alt-tek.com/api-token.
Restrict access to your API token by setting its file permissions
accordingly (i.e. 'chmod 600 ~/.config/git.alt-tek.com/api-token').
- In order to generate releases, SSH must be configured for git.alt-tek.com
such that SSH Git commands can be executed without explicitly specifying
an SSH identity or private key
RELEASING
1. See above dependencies
2. Create an annotated Git tag for the release commit using
"git tag -a v<version> -m 'Version <version>' <commit>" where version is
the board version in X.Y.Z form and <commit> is the commit hash
(e.g. "git tag -a v1.2.3 -m 'Version 1.2.3' d15c0cafe")
3. Push the tag upstream (i.e. 'git push origin tags/v<version>')
4. Use the release script to build the release and upload it as a draft
(i.e. './release <version>')
5. Review the release draft. If it is ready for pre-release or production,
publish it.