Merge branch 'dev' into Short-Detection

2 files changed, 46 insertions, 25 deletions

diff --git a/Makefile b/Makefile
index 40d6b8b2..51a7971c 100644
--- a/Makefile
+++ b/Makefile
@@ -19,8 +19,6 @@ ifdef DOCKER_COMPOSE
 DOCKER_BIN:=$(DOCKER_COMPOSE)

 else ifdef DOCKER_TOOL

 DOCKER_BIN:=$(DOCKER_TOOL) compose

-else

-$(error ERROR: Can't find docker-compose nor docker tool. Please, install docker and try again)

 endif # DOCKER_* checks

 endif # DOCKER_BIN

 

@@ -64,14 +62,15 @@ help:
 list:

 	@echo ""

 	@echo "Supported top-level targets:"

-	@echo "\t * help - shows short basic help"

-	@echo "\t * list - this output"

+	@echo "\t * help         - shows short basic help"

+	@echo "\t * list         - this output"

 	@echo "\t * docker-shell - start docker container with shell inside to work on IronOS with all tools needed"

 	@echo "\t * docker-build - compile builds of IronOS for supported models inside docker container and place them to \"scripts/ci/artefacts/\""

 	@echo "\t * docker-clean - delete created docker container (but not pre-downloaded data for it)"

-	@echo "\t * docs - generate \"site\"/ directory with documentation in a form of static html files using ReadTheDocs framework and $(MKDOCS_YML) local config file"

-	@echo "\t * docs-deploy - generate & deploy docs online to gh-pages branch of current github repo"

-	@echo "\t * clean-full - delete files & directories generated by all the targets above "

+	@echo "\t * docs         - generate \"site\"/ directory with documentation in a form of static html files using ReadTheDocs framework and $(MKDOCS_YML) local config file"

+	@echo "\t * docs-deploy  - generate & deploy docs online to gh-pages branch of current github repo"

+	@echo "\t * clean-build  - delete generated files & dirs produced during builds EXCEPT generated docker container image"

+	@echo "\t * clean-full   - delete generated files & dirs produced during builds INCLUDING generated docker container image"

 	@echo ""

 	@echo "NOTES on supported pass-trough targets:"

 	@echo "\t * main Makefile is located in source/ directory and used to build the firmware itself;"

@@ -91,16 +90,25 @@ list:
 # bash one-liner to generate langs for "make list":

 # echo "`ls Translations/ | grep -e "^translation_.*.json$" | sed -e 's,^translation_,,g; s,\.json$,,g; ' | tr '\n' ' '`"

 

+# detect availability of docker

+docker-check:

+ifeq ($(DOCKER_BIN),)

+	@echo "ERROR: Can't find docker-compose nor docker tool. Please, install docker and try again"

+	@exit 1

+else

+	@true

+endif

+

 # former start_dev.sh

-docker-shell: $(DOCKER_DEPS)

+docker-shell: docker-check  $(DOCKER_DEPS)

 	$(DOCKER_CMD)

 

 # former build.sh

-docker-build: $(DOCKER_DEPS)

+docker-build: docker-check  $(DOCKER_DEPS)

 	$(DOCKER_CMD)  /bin/bash  /build/ci/buildAll.sh

 

 # delete container

-docker-clean:

+docker-clean: docker-check

 	-docker  rmi  ironos-builder:latest

 

 # generate docs in site/ directory (DIR for -d is relative to mkdocs.yml file location, hence use default name/location site by setting up ../site)

@@ -115,11 +123,14 @@ docs-deploy: $(MKDOCS_YML)  Documentation/*  Documentation/Flashing/*  Documenta
 %:

 	make  -C source/  $@

 

-# global clean-up target

-clean-full: docker-clean

+# global clean-up target for produced/generated files inside tree

+clean-build:

 	make  -C source/  clean-all

 	rm  -Rf  site

 	rm  -Rf  scripts/ci/artefacts

 

-.PHONY:  docker-shell  docker-build  docker-clean  docs  clean-full

+# global clean-up target

+clean-full: clean-build  docker-clean

+

+.PHONY:  help  list  docker-check  docker-shell  docker-build  docker-clean  docs  docs-deploy  clean-build  clean-full

 

diff --git a/README.md b/README.md
index f1cbc655..4053e3f2 100644
--- a/README.md
+++ b/README.md
@@ -21,18 +21,28 @@ This project is considered feature complete for use as a soldering iron, _so ple
 
 _This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited on a computer and flashed like firmware._
 
-|   Device   | DC  | QC  | PD  | EPR | BLE | Battery | Recommended |
-| :--------: | :-: | :-: | :-: | :-: | :-: | :-----: | :---------: |
-|   MHP30    | ❌  | ❌  | ✔️  | ❌  | ❌  |   ❌    |      ✔️       |
-| Pinecil V1 | ✔️  | ✔️  | ✔️  | ❌  | ❌  |   ✔️    |      ✔️       |
-| Pinecil V2 | ✔️  | ✔️  | ✔️  | ✔️  | ✔️  |   ✔️    |      ✔️       |
-|   TS80P    | ❌  | ✔️  | ✔️  | ❌  | ❌  |   ✔️    |      ✔️       |
-|   TS100    | ✔️  | ❌  | ❌  | ❌  | ❌  |   ✔️    |      ❌*      |
-|    TS80    | ❌  | ✔️  | ❌  | ❌  | ❌  |   ✔️    |     ❌**      |
-
-\*Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is **_no longer recommended_**.
-
-\**TS80 is replaced by TS80P. Production ramped down a long time ago and it's just existing stock clearing the system. It's marked not recommended being optimistic that people might pause and buy the far superior TS80P instead. This is the main reason why the TS80 is **_no longer recommended_**.
+|   Device       | DC  | QC  | PD  | EPR | BLE | Tip Sense | Recommended Purchase | Notes                                         |
+| :------------: | :-: | :-: | :-: | :-: | :-: | :-----:   | :------------------: | :-------------------------------------------:|
+| Miniware MHP30 | ❌  | ❌  | ✔️  | ❌  | ❌  |   ✔️      |      ✔️              |                                              |
+| Pinecil V1     | ✔️  | ✔️  | ✔️  | ❌  | ❌  |   ❌      |      ❌ *            |                                              |
+| Pinecil V2     | ✔️  | ✔️  | ✔️  | ✔️  | ✔️  |   ✔️      |      ✔️              |                                              |
+| Miniware TS101 | ✔️  | ❌  | ✔️  | ✔️  | ❌  |   ✔️      |      ✔️              |  Full OLED resolution not yet supported.     |
+| Sequre  S60    | ❌  | ❌  | ✔️  | ❌  | ❌  |   ❌      |      ✔️              |  Full OLED resolution not yet supported.     |
+| Miniware TS80P | ❌  | ✔️  | ✔️  | ❌  | ❌  |   N/A     |      ✔️              |                                              |
+| Miniware TS100 | ✔️  | ❌  | ❌  | ❌  | ❌  |   ❌      |      ❌**            |                                              |
+| Miniware TS80  | ❌  | ✔️  | ❌  | ❌  | ❌  |   N/A     |     ❌***            |                                              |
+
+_Tip Sense_ refers to the device being able to choose between the 'usual' TS100 or Hakko T12 style tips and Pine64's custom shorter tips which have lower resistance and allow for more power. This is N/A for TS80/TS80P as there is only one model of tip for them.
+
+_Recommended Purchase_ is only referring to if you are buying a **new** device. Of course all the devices listed are supported and will work excellently for years to come.
+
+The TS101 and S60 feature a higher resolution OLED than other devices. Work is ongoing to support this fully, for now a cropped view is usable.
+
+\*PinecilV1 stopped being manufactured a long time ago now, all models for sale online are generally clones (or old stock). Vendors are trying to sell these for more than Pine64 sells the V2 for now. Thus the V1 is **_no longer recommended_**.
+
+\**Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is **_no longer recommended_**.
+
+\**\*TS80 is replaced by TS80P. Production ramped down a long time ago and it's just existing stock clearing the system. It's marked not recommended being optimistic that people might pause and buy the far superior TS80P instead. This is the main reason why the TS80 is **_no longer recommended_**.
 
 ## Getting Started