From 30c470cbf1186b4e32334d52fc7c73dd1811902d Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Sun, 6 Sep 2020 14:00:35 +1000 Subject: [PATCH] Remove old codeship + docs updates --- .../Development.md | 0 History.md => Documentation/History.md | 93 +++++++++++++++---- menu.md => Documentation/Menu.md | 0 power.md => Documentation/Power.md | 0 .../Translation.md | 0 upgrading.md => Documentation/Upgrading.md | 0 ISSUE_TEMPLATE.md | 40 +++----- PULL_REQUEST_TEMPLATE.md | 11 +-- README.md | 9 +- codeship-services.yml | 8 -- codeship-steps.yml | 6 -- 11 files changed, 94 insertions(+), 73 deletions(-) rename development.md => Documentation/Development.md (100%) rename History.md => Documentation/History.md (64%) rename menu.md => Documentation/Menu.md (100%) rename power.md => Documentation/Power.md (100%) rename Translation.md => Documentation/Translation.md (100%) rename upgrading.md => Documentation/Upgrading.md (100%) delete mode 100644 codeship-services.yml delete mode 100644 codeship-steps.yml diff --git a/development.md b/Documentation/Development.md similarity index 100% rename from development.md rename to Documentation/Development.md diff --git a/History.md b/Documentation/History.md similarity index 64% rename from History.md rename to Documentation/History.md index 8c54ee99..0a81bddc 100644 --- a/History.md +++ b/Documentation/History.md @@ -1,5 +1,64 @@ # Version Changes -V2.00 + +## V2.11 + +* First TS80P support +* Added in a USB-PD driver stack for the FUSB302 +* Fixed some graphical glitches + +## V2.10 + +* GUI polish (animations and scroll bars) +* Power pulse to keep power supplies alive +* Adjustable tip response gain + +## V2.09 + +* Adjustable steps in temperature adjustment +* Git hash now in build string +* Adjustable language to set if US units are available or not +* Some minor QC3 improvements + +## V2.08 + +* Fixes auto start in sleep mode +* Power limiters + +## V2.07 + +* QC fixes +* Cosmetic fixes for leading 0's + +## V2.06 + +* Warning on settings reset +* Temp temp re-write +* Display calibration offset +* Hide some leading 0's +* Menu timeouts + +## V2.05 + +* Language updates + + +## V2.04 + +* GUI updates + +## V2.03 + +* Support for new accelerometers + +## V2.02 + +* Adds small font + +## V2.01 + +* Newer settings menu + +## V2.00 * Complete re-write of the low layer system to use the STM32 HAL for easier development * This allowed easier setup for the new ADC auto measuring system @@ -10,80 +69,80 @@ V2.00 * Added smaller font for said screen views -V1.17 +## V1.17 * Added blinking cooldown display * Allowed smaller sleep timeout values * New font! * Automatic startup option -V1.16 +## V1.16 * Added automatic rotation support * Added power display graph -V1.15 +## V1.15 * Added support for a custom bootup logo to be programmed via the DFU bootloader -V1.14 +## V1.14 * Changed input voltage cutoff to be based on cell count rather than voltage -V1.13 +## V1.13 * Swapped buttons for menu to prevent accidentally changing first menu item * Added auto key repeat -V1.12 +## V1.12 * Increases sensitivity options to be 1*9 with 0 off state * Fixes issue where going from COOL *> soldering can leave screen off -V1.11 +## V1.11 * Boost mode * Change sensitivity options to be 1*8 -V1.10 +## V1.10 * Adds help text to settings * Improves settings for the display update rate -V1.09 +## V1.09 * Adds display modes, for slowing down or simplifying the display -V1.08 +## V1.08 * Fix settings menu not showing flip display -V1.07 +## V1.07 * Adds shutdown time to automatically shutdown the iron after inactivity -V1.06 +## V1.06 * Changes H and C when the iron is heating to the minidso chevron like images -V1.05 +## V1.05 * Adds ability to calibrate the input voltage measurement -V1.04 +## V1.04 * Increased accuracy of the temperature control * Improved PID response slightly * Allows temperature offset calibration * Nicer idle screen -V1.03 +## V1.03 * Improved Button handling * Ability to set motion sensitivity * DC voltmeter page shows input voltage -V1.02 +## V1.02 * Adds hold both buttons on IDLE to access the therometer mode * Changes the exit soldering mode to be holding both buttons (Like original firmware) diff --git a/menu.md b/Documentation/Menu.md similarity index 100% rename from menu.md rename to Documentation/Menu.md diff --git a/power.md b/Documentation/Power.md similarity index 100% rename from power.md rename to Documentation/Power.md diff --git a/Translation.md b/Documentation/Translation.md similarity index 100% rename from Translation.md rename to Documentation/Translation.md diff --git a/upgrading.md b/Documentation/Upgrading.md similarity index 100% rename from upgrading.md rename to Documentation/Upgrading.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 721a76f5..05250381 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,31 +1,21 @@ Please edit this template and fill out all the information you can (where relevant). Failure to provide essential information can delay the response you receive. +_This is a [Bug/Feature Request/Question/Complaint]_ -* **I'm submitting a ...** - - [ ] Bug report - - [ ] Feature request - - [ ] Translation - - -* **Do you want to request a *feature* or report a *bug*?** - - +* **I have** + - [ ] Searched previous issues + - [ ] This is in _this_ firmware, not vendor "offical" firmware + - [ ] This is not a bug in the vendor bootloader (aka DFU) + - [ ] I have checked this is not already covered in the docs in `/Documentation` * **What is the current behavior?** - * **What is the expected behavior?** +***Steps to reproduce the bug:*** -* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** - -***Steps to reproduce:*** - -1. -2. -3. - -***Video of problem if hard to reproduce*** +- Turn on... +- Hold.... * **What is the motivation / use case for changing the behavior?** @@ -33,13 +23,9 @@ Please edit this template and fill out all the information you can (where releva * **What are you running:** -On the idle screen, you can hold the settings button and it will show you the firmware version. +On the idle screen, you can hold the settings button and it will show you the firmware & PCB version. +If using a USB-C supply please note model number - - Firmware Version: 2.x + - Firmware Version: 2.x? - PCB Version: (1/2) - - Power Supply (Voltage and Current Rating) : - - -* **Other information** - -If submitting graphics to go on the iron, please use BMP or PNG files over JPG. + - Power Supply (Voltage and Current Rating) : \ No newline at end of file diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 6b353fec..09867702 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -2,9 +2,8 @@ Please try and fill out this template where possible, not all fields are required and can be removed. * **Please check if the PR fulfills these requirements** -- [] The commit message makes sense - [] The changes have been tested locally -- [] Are there any breaking changes +- [] There are no breaking changes * **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) @@ -14,14 +13,6 @@ Please try and fill out this template where possible, not all fields are require * **What is the current behavior?** (You can also link to an open issue here) - - * **What is the new behavior (if this is a feature change)?** - - -* **Does this PR introduce a breaking change?** -(What changes might users need to make in their application due to this PR?) - - * **Other information**: diff --git a/README.md b/README.md index 5fa9c60e..d54f1eab 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[![Codeship Status for ts100](https://app.codeship.com/projects/c77dbfe0-0764-0138-9520-3eb35bdb2b2c/status?branch=master)](https://app.codeship.com/projects/379118) ![C/C++ CI](https://github.com/Ralim/ts100/workflows/C/C++%20CI/badge.svg) # Flexible Soldering iron control Firmware @@ -33,7 +32,7 @@ This project is considered feature complete for use as a soldering iron, *so ple * Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time) * (TS100) Battery charge level indicator if power source set to a lipo cell count * (TS80) Power bank operating voltage is displayed -* [Custom boot up logo support](upgrading.md) +* [Custom boot up logo support](Documentation/upgrading.md) * Automatic LCD rotation based on the orientation * Supports both the version 1 and version 2 hardware (different accelerometers) @@ -47,7 +46,7 @@ When on the main screen, the unit shows prompts for the two most common operatio * Holding the button near the tip will enter soldering temperature adjust mode (This is the same as the one in the soldering menu, just to let you edit before heating up) * Holding the button near the USB end will show the firmware version details -Detailed operation details are over in the [Menu information.](menu.md) +Detailed operation details are over in the [Menu information.](Documentation/menu.md) ## Thanks @@ -64,11 +63,11 @@ Especially to the following users, who have helped in various ways that are mass * [Doegox](https://github.com/doegox) * [Perillamint](https://github.com/perillamint) * [GeminiServer](https://github.com/GeminiServer) -* [PixelPirate](https://github.com/PixelPirate) +* [Patrick Horlebein](https://github.com/PixelPirate) * [Firebie](https://github.com/Firebie) * [Agatti](https://github.com/agatti) * [Discip](https://github.com/discip) - +* [Paul Fertser](https://github.com/paulfertser) ## Licence The code created by the community is GNU GPLv3. Unless noted elsewhere. diff --git a/codeship-services.yml b/codeship-services.yml deleted file mode 100644 index aafb9325..00000000 --- a/codeship-services.yml +++ /dev/null @@ -1,8 +0,0 @@ -builder: - build: - context: . - dockerfile: Dockerfile - cached: true - encrypted_env_file: ci/secrets/encrypted/deployment.encrypted - volumes: - - ./ci:/ci diff --git a/codeship-steps.yml b/codeship-steps.yml deleted file mode 100644 index ce87ca1d..00000000 --- a/codeship-steps.yml +++ /dev/null @@ -1,6 +0,0 @@ -- type: parallel - name: Build the firmware - steps: - - name: build - service: builder - command: /build/ci/buildAll.sh