search

konnected-io / konnected-security

Konnected connects wired sensors and switches to SmartThings, Home Assistant, Hubitat and OpenHAB
https://konnected.io
Apache License 2.0
416 stars 322 forks source link

Update build documentation and scripts #104

Closed kit-klein closed 5 years ago

kit-klein commented 5 years ago

This PR includes update and cleanup for the firmware build/flash/docs.

  1. The firmware folder has been refactored to include a single folder for the most recent nodeMCU overlay instead of version specific overlays. The latest overlay should now always be in the firmware/nodemcu-firmware-overlay. Contents of this will be copied into the nodemcu-firmware as part of the build process.

  2. Releases have been moved into the firmware/releases folder. Each new release should be copied here for ease of access when flashing.

  3. The build-firmware script has been updated to accept an argument indicating the version (no more script file editing needed). Outputs of the build will be located in firmware/builds within a folder named according to the version.

  4. The flash script has been updated to use version and port arguments. It will first look for the version within the firmware/builds directory. If no matching version is found it will fall back to look in firmware/releases. Once a match is found the flash will commence.

  5. README has been updated to reflect the changes above and to elaborate more on the fw build process.