1
0
forked from me/IronOS
Commit Graph

206 Commits

Author SHA1 Message Date
Ivan Zorin
53bb8355f8 docs/History.md: add info for 2.20 & 2.21 (#1804)
docs/changelog: update info for 2.20 & 2.21
2023-08-20 09:55:38 +10:00
Ivan Zorin
5754622fea Include History.md to online docs as Changelog (#1799)
docs/changelog: include History.md to read-the-docs site generating as Changelog, update titles formatting & unify style between sections
2023-08-16 10:06:55 +10:00
Ivan Zorin
4cb47cf1a2 Add detailed OLED replacement info to Troubleshooting document (#1797)
* Add OLED replacement info to HardwareIssues document

* Update formatting & text

* Move OLED replacement detailed info from HardwareIssues to Troubleshooting inside the related section
2023-08-14 11:12:52 +10:00
Ivan Zorin
33439aaa22 Include Bluetooth document to read-the-docs site generating (#1798) 2023-08-14 11:11:54 +10:00
Ben V. Brown
c0f1c35ba5 Update logo flashing information (#1787)
* Update logo information

* Update Documentation/Logo.md

---------

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-08-08 09:45:54 +10:00
Ivan Zorin
15ab87f3bc Update tagging for detached commit case & update docs (#1783)
make_translation.py: update tagging for detached commit case & update docs
2023-08-07 09:05:56 +10:00
Ivan Zorin
97c0fee358 Implement proper git SHA ID marking for builds during pull-requests (#1772)
* debug github CI git meta info

* fix push.yml format

* fix push.yml for shell

* try to fix push.yml

* try to fix push.yml run

* try to fix push.yml run for multi

* keep debugging

* try to do as less changes as possible

* Implement proper git tagging for builds during pull-requests

* Unify new-line separators between build steps

* Keep debugging

* make_translation.py: fix formatting

* push.yml: try to set ENV values

* push.yml: fix copy-paste error

* Remove extra env var

* Experimenting

* Testing upper()

* Re-testing upper()

* Revert tested values

* make_translation.py: add new lines between blocks to improve readability

* Reformulate docs & comments

* make_translation.py: remove debugging print

* make_translation.py: simplify check for SHA ID env var / code review

* make_translation.py: fix condition

---------

Co-authored-by: Ben V. Brown <5425387+Ralim@users.noreply.github.com>
2023-08-04 21:54:29 +10:00
Ben V. Brown
584b3826c3 Start docs on BLE (#1763)
* docs on BLE

* Tip shorted notes
2023-08-01 02:39:29 +02:00
Ivan Zorin
1c9d3940ca Move related pieces of documentation from wiki to Documentation/ (#1746)
* Move TS100 info from wiki to Hardware.md

* Move TS80 info from wiki to Hardware.md

* Move TS80P info from wiki to Hardware.md

* Move Pinecil info from wiki to Hardware.md

* Move some info from Home.md wiki to Documentation/index.md

* Fix path inside docker since Dockerfile has been updated to be in the root project tree after starting container

* Move info from Home.md wiki to Documentation/Hardware.md

* mkdocs.yml: swtich config to forked repo for testing formatting online

* Fix formatting

* Fix formatting (md != rtd)

* Fix formatting for index.md

* Revert mkdocs config to original one after testing

* Documentation/: add power sources info

* Documentation/README.md: update with power sources

* tiny fixes with formatting

* Reformat links to stores

* Fix footnote on _default_ charger for TS80P

* Revert mkdocs config

* Fix footnote about wattage for QC, try fix table in index.md
2023-07-20 11:55:08 +10:00
Ivan Zorin
1d820acbee Documentation/index.md: add Feedback section (Ralim#1552) as suggested (#1744) 2023-07-18 14:35:16 +10:00
Ivan Zorin
4649df6914 Implement autogeneration of Documentation/README.md (#1738)
* mkdocs.yml: unify formatting style

* Docs/README.md: add auto-generated README.md file for Documentation/ directory

* Docs/README.md: fix refs

* Docs/README.md: fix locations

* Docs/README.md: trying workaround spaces in filenames for refs

* Documentation/README.md: update generated file trying to fix all formatting issues

* Documentation/README.md: reduce title size

* Documentation/README.md: add link for official online docs

* scripts/deploy.sh: implement docs_readme function

* deploy.sh: add overwrite warning in help output

* deploy.sh: try to fix shellcheck warnings

* deploy.sh:docs_readme() - show note message only if README should be updated

* deploy.sh:docs_readme() - fix shellcheck

* github/push: add Documentation/README.md check

* github/push: force usage of /bin/sh for deploy.sh script

* testing, testing, testing

* deploy.sh:docs_readme() - make error-related message more clear about what to donext

* Revert change used only to test failure on github CI
2023-07-11 09:36:05 +10:00
Ivan Zorin
cd7696b66f Suggestion to update BUILD_VERSION policy (#1733)
* version.h: update BUILD_VERSION policy / PoC

* Fix misplaced chars

* make_translation.py: implement get_version_suffix() function to extend BUILD_VERSION build type legend data

* version.h: update version policy info according to implementation of get_version_suffix() function in make_translation.py

* Version policy update: add double-check for release tag so if version doesn't match use another letter T

* make_translation.py: fix extra tabulation

* version.h: tiny tidy update for version format

* Documentation/DebugMenu.md: update info on version line & date

* Documentation/DebugMenu.md: fix formatting & mistypes

---------

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-07-10 09:58:24 +10:00
Ivan Zorin
b524a99ff2 Root directory content refactoring (#1725)
* Root directory refactoring: - move info about Bootup Logo from a sepatate README to main README; - replace separate root scripts build.sh and start_dev.sh by root Makefile; - make Scripts directory and move there: flash_ts100_linux.sh script, ci/ directory, dockerfile, LICENSE_RELEASE, and PULL_REQUEST_TEMPLATE; - reconfigure build & deploy scripts according to changes

* Scripts => scripts

* Scripts -> scripts: re-add missing renamed files

* Directories refactoring: add top-level Makefile, add scripts/deploy.sh script, move github templates from top-level dir to .github, organize files inside Development Resources

* Update scripts/deploy.sh accroding to codestyle syntax shellcheck

* Makefile: add docs-deploy target for mkdocs gh-deploy

* Rename IronOS.yml > Env.yml, update related files

* Docs configs: remove empty characters

* docs/devel: update usage of new script
2023-07-02 11:32:40 +10:00
Laura
366b3356da Update Documentation/Menu.md
Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-04-25 19:11:06 +02:00
Laura
2745221643 Update Documentation/GettingStarted.md
Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2023-04-25 19:09:36 +02:00
discip
d94978f1ce Adjusted CJK and generalized some descriptions 2023-04-25 18:43:59 +02:00
Laura Klünder
578fd54463 soldering profile mode → profile mode 2023-04-25 11:56:57 +02:00
Laura Klünder
9559af39f7 add documentation for soldering profile mode 2023-04-25 11:56:57 +02:00
Vladimir
6177d4e2a4 Add building steps for Pinecil V2 to Development.md (#1634) 2023-03-24 13:19:52 +00:00
Adam Patridge
9247075458 Fix Markdown link typo 2023-03-20 11:30:26 -07:00
Adam Patridge
d834a3395c Update settings icon description 2023-03-20 11:23:24 -07:00
River M
344c1a649d Update documents, esp. Pinecil V2 instructions (#1604)
* Update README.md

* Update Pinecil V2.md

* Update Pinecil V2.md

update very outdated instructions on how to update Pinecil V2.

* Update Pinecil V1.md

* Update Pinecil V2.md

* Update Pinecil V2.md
2023-03-02 17:58:46 +11:00
Ben V. Brown
0b6c5ff837 👋 Goodbye Weblate
Dropping weblate for now as its just not reliable.
2023-01-30 17:26:41 +11:00
Ben V. Brown
05628daba2 Merge branch 'dev' into new-translations-format 2023-01-22 22:05:13 +11:00
discip
7fd7873b62 updated Menu.md (#1512)
Update Menu.md
2022-12-31 22:54:45 +11:00
Ben V. Brown
ec675da1d6 Update Translation.md 2022-12-07 18:37:40 +11:00
discip
8512da71ce solving issue #1423 2022-10-31 01:09:54 +01:00
discip
0199af1521 Update Settings.md 2022-10-27 17:53:27 +02:00
discip
7aa3b38696 cleared up some wording along with some typo fixes 2022-10-27 17:28:40 +02:00
Ben V. Brown
6fab3e5252 Generate a mkdocs github page + Migrate documentation links to use it (#1414)
* Approx first pass?

* Update docs.yml

* Filling out menu

* Update GettingStarted.md

* Index docs links

* Update index.md

* Update README.md

* Link redirection

* More link rewrite

* Update HallSensor.md

* Split up flashing

* Derp

* Flashing links
2022-09-22 13:10:01 +10:00
discip
c89db78b45 Calibrate CJC at next boot (#1398)
Changes Cold Junction Compensation (Tip Offset / CJC) to be performed during bootup time. (After starting in settings)
2022-09-10 20:52:57 +10:00
Ben V. Brown
c99a199520 | spacer 2022-09-01 22:31:33 +10:00
Ben V. Brown
307b6c76f8 Fix deg C symbol 2022-09-01 22:29:49 +10:00
River B
904428ee19 Updated documents, fixed English Translation (#1400)
* Update translations_def.js

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update DebugMenu.md

* Update DebugMenu.md

* Update Development.md

* Update Flashing.md

* Update GettingStarted.md

* Update GettingStarted.md

* Update GettingStarted.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update HardwareIssues.md

* Update Logo.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update translation_EN.json

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update README.md

* Update translation_FR.json

* Update README.md

* Update Power.md

* Update Troubleshooting.md

* Update Troubleshooting.md

* Update Troubleshooting.md

* Update HardwareIssues.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update Power.md

* Update Power.md

* Update Power.md

* Update Menu.md

* Update Power.md

* Update Documentation/Settings.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update Translations/translation_EN.json

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update Settings.md

* Update translation_EN.json

* Update Documentation/Settings.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Update translation_EN.json

* Add files via upload

* Update translation_EN.json

* Update Settings.md

* Add files via upload

* Update Settings.md

* Update Settings.md

* Update Settings.md

* Add files via upload

* Delete translation_EN.json

* Add files via upload

* Update Power.md

* Update Power.md

* Add files via upload

* Update Settings.md

* Add files via upload

* handle font with no symbols to contribute

* Format

* Generate settings.md menu dock

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
Co-authored-by: Ben V. Brown <Ralim@Ralimtek.com>
2022-09-01 21:14:39 +10:00
discip
b5323d9c77 reorder debug menu . . . (#1380)
* Update DebugMenu.md

* Update make_translation.py

* Update GUIThread.cpp

* Update DebugMenu.md
2022-08-25 09:17:15 +10:00
River B
3895218b2d Clarify and add details to documents (#1383)
* Update README.md

* Update Menu.md

Thoughts:
- changing the name in display to "Calibrate Tip Offset" (currently shows Calibrate temperature) might be more clear, and then people will not get  nervous and think the number displayed means temperature? since it is just a number, i.e., 765,  and does not say  "765 offset"    I suggest changing to either  "number Offset"   or  changing menu name to "Calibrate Tip Offset"  .  when people incorrectly  beleive the high number is temperature, since it says "calibrate temperature?"  then it leads to unwarranted concern that the pinecil or IronOS is broken.

* Update Menu.md

* Update Temperature.md

clarify language, add punctuation.

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update Flashing.md

* Update HallSensor.md

* Update GettingStarted.md

* Update DebugMenu.md

* Update GettingStarted.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update HallSensor.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update Menu.md

* Update History.md

* Update History.md

updated history with some of the Releases that were missing.

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update README.md

* Update Temperature.md

* Update DebugMenu.md

* Update Flashing.md

* Update Flashing.md

* Update Temperature.md

* Update Temperature.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update Temperature.md

* Update Temperature.md

* Update Temperature.md

* Update Temperature.md

* Update README.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

* Update Temperature.md

* Update Troubleshooting.md

In which troubleshooting conditions/symptoms would:

(1) Re-calibrating  tip offset temperature be appropriate?
(2) Re-Calibrating Input voltage be appropriate?

I think these 2 internal tests would be helpful sections for Troubleshooting, but not sure of all details to write-up.

* Update GettingStarted.md

Co-authored-by: discip <53649486+discip@users.noreply.github.com>
2022-08-25 09:16:05 +10:00
Ben V. Brown
1fbcdcdf98 Pinecil V2 (#1341)
* Add SDK

* fork

* massaging makefile

* Drop git module

* Bring in sdk as its broken

Far, Far to much crap to fix with regex now

* Remove bl706

* rf_para_flash_t is missing defs

* Remove crapton of junk

* Remove yet more

* Poking I2C

* Update peripheral_config.h

* Update pinmux_config.h

* Update preRTOS.cpp

* Update main.hpp

* Setup template

* Verbose boot

* I2C ish

* Update I2C_Wrapper.cpp

* Update main.cpp

* Turn off I2C reading for now

* Display running

* Roughing out scheduling timer0

* Starting ADC setup

* Working scheduling of ADC 🎉

* Format adc headers

* Update IRQ.cpp

* Buttons working

* Slow down I2C

* Poking IRQ

* Larger stack required

* Accel on

* Trying to chase down why __libc_init_array isnt working yet

* Working c++

* Cleanup

* Bump stacks

* I2C wake part workaround

* Cleanup

* Working PWM init

* qc draft

* Hookup PWM

* Stable enough ADC

* ADC timing faster + timer without HAL

* Silence

* Remove boot banner

* Tuning in ADC

* Wake PID after ADC

* Remove unused hal

* Draft flash settings

* Working settings save & restore

* Update to prod model

* Cleanup

* NTC thermistor

* Correct adc gain

* Rough tip resistance progress

* Scratch out resistance awareness of the tip

* better adc settings

* Tweaking ADC

* ADC tweaking

* Make adc range scalable

* Update Dockerfile

* Update configuration.h

* Can read same ADC twice in a row

* ADC Setup

* Update PIDThread.cpp

* Lesser adc backoff

* Update USBPD.h

* Add device ID

* Update BSP_Power.h

* Update BSP.cpp

* DrawHex dynamicLength

* Shorter ID padding

* Show validation code

* tip measurement

* Create access for w0w1

* Expose w0 w1

* Enable debug

* crc32

* Device validation

* wip starting epr

* Logic refactor

* Safer PWM Init

* PD cleanups

* Update bl702_pwm.c

* Update power.cpp

* Update usb-pd

* io

* EPR decode

* Better gui for showing pd specs

* Rough handler for capabilities

* EPR

* Fix > 25V input

* Perform pow step after PPS

* Update BSP.cpp

* Fix timer output

* QC3

* Add tip resistance view

* Hold PD negotiation until detection is done for tip res

* Get Thermal mass

* Tip res =0 protection

* Update PIDThread.cpp

* Update GUIThread.cpp

* Rewrite tip resistance measurement

* Update GUIThread.cpp

* Fix fallback

* Far better tip resistance measurement

* Fix QC 0.6V D-

* Convert the interpolator to int32

* Correct the NTC lookup

* Update BSP.cpp

* Update Setup.cpp

* .

Update configuration #defines

More backported functions

* Update usb-pd

* More missed updates

* Refactor BSP

Magic BSP -> PinecilV2
Pine64 BSP -> Pinecil

Update Makefile

* Add Pinecilv2 to CI

* Pinecil v2 multi-lang

Update push.yml

* Update HallSensor.md

* Update README.md

* Fix wrong prestartcheck default

* Fix logo mapping

* Update Makefile

* Remove unused font block

* Style

* Style

* Remove unused timer funcs

* More culling TS80P

* Revert "More culling TS80P"

This reverts commit 2078b89be7.

* Revert "Remove unused timer funcs"

This reverts commit 0c693a89cc.

* Make VBus check maskable

* Remove DMA half transfer

* Drop using brightness and invert icons and go back to text

Saves flash space

* Refactor settings UI drawing descriptions

* Shorten setting function names

* Store bin file assets

* Fix MHP prestart
2022-08-19 15:39:37 +10:00
River B
61a679115d Update DebugMenu.md (#1366) 2022-08-13 20:32:12 +10:00
River B
cf5f09fa3c Update DebugMenu.md (#1367) 2022-08-13 20:31:46 +10:00
River B
638a365881 update Debug info (#1358)
* Update README.md

* Update README.md

* Delete Logo.md

* Create Logo.md

* Update Logo.md

* Update Logo.md

* Update Logo.md

* Update Logo.md

* Update Logo.md

* Update README.md

* Update README.md

* Update Logo.md

* Update Logo.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md

* Update DebugMenu.md
2022-08-07 12:10:44 +10:00
River B
eebf65f83c document updates (#1355) 2022-08-05 09:50:11 +10:00
River B
cac8a205d3 Update HallSensor.md 2022-08-03 08:28:53 -07:00
River B
3412e17379 Update Logo.md 2022-08-02 23:23:10 -07:00
River B
f269a1002f Update Logo.md 2022-08-02 23:22:06 -07:00
Björn Lange
e562c3a9f1 Add USB autosuspend to troubleshooting for Pinecil 2022-05-17 20:22:15 +02:00
Ben V. Brown
c0b9440540 Merge branch 'master' into patch-3 2022-04-22 19:49:28 +10:00
Kryštof Černý
0a00e3fee3 Update the upper part of the document 2022-04-19 13:18:52 +02:00
Kryštof Černý
210f1a2ff0 Fix in Troubleshooting.md 2022-04-19 13:07:12 +02:00
Kryštof Černý
c68cedf8cf Fix in Power.md 2022-04-19 13:01:40 +02:00
Kryštof Černý
d808345b5b Typo fix in Logo.md 2022-04-19 13:00:41 +02:00