diff --git a/search/search_index.json b/search/search_index.json
index bfcadb42..4ea6f114 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#pinecil-settings-and-menus","title":"Pinecil Settings and Menus","text":"
Why focus on soldering when you can play with the settings instead? With this app you have full control over your new shiny Pinecil V2 from your computer using bluetooth.
NB: No special browser flags or BLE GATT required; works on all major OS and phones.
NB: This app needs the backend to start on a computer terminal; then the user interface runs from any browser. It CANNOT run entirely by only opening a browser like Joric's UI.
Full settings view "},{"location":"#supports","title":"Supports","text":"System MacOS Linux Windows Phones UI backend"},{"location":"#features","title":"Features","text":"
Automatically detect Pinecil V2 over BLE.
Control all settings on the device.
Save to Flash: toggle to save changes directly onto Pinecil (leave off unless actively changing settings).
Work HUD main screen has: buttons + - to change temperature, live updates, peak and live watts, input voltage.
Preset buttons allow quick change of user defined temperatures (PineSAM extra feature not available directly inside Pinecil).
Backend runs locally on all major platforms/OS while the user interface runs on your favorite browser.
Try to read the documents and search the issue tracker to find answers before posting a new issue.
Follow the template in the issue ticket and include all details requested.
Be prepared to answer questions or give additional information. Issues where the creator does not follow up to questions will be marked stale and closed.
If the documents are lacking or there is a typo, consider improving it or open an issue ticket if you are not comfortable digging into a full Github Pull Request. Translating PineSAM into different languages is another way to help.
Code contributions are welcome. Just fork the code and submit well commented and clean commits to the repository. Perform a pull pequests (pr) to the /dev branch. Check out some of the open issue tickets or propose new features. If there is no existing ticket related to the PR, then create a ticket outlining what issues are being addressed.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"},{"location":"install-guide/dev-scripts/#mac-or-linux-dev","title":"Mac or Linux dev","text":""},{"location":"install-guide/dev-scripts/#setup","title":"Setup","text":"
First, install all packages linked above in dependencies.
Follow the additional hints below to install all packages linked above in dependencies.
Python install notes
Check \"Add python.exe to PATH\" and select \"Customize Installation\"
Check \"Add Python to environment variables\" option
Screenshots of options to select are here.
Install NodeJS here, accept all prompts to add packages during install including a prompt in the terminal that opens.
After installing packages listed for backend script (reference), go to System Environment variables to check paths (image).
Download the Source-all-__.zip from the latest releases.
Right-click the zip > properties, if it has an Unblock option, then unblock and extract it (example).
Run powershell as administrator, set permissions to RemoteSigned (reference). Setting this one time in powershell is usually enough as it persists on reboot.
C:\\> Set-ExecutionPolicy RemoteSigned\n
Then check that powershell permissions are correct; at minimum, need LocalMachine to show as RemoteSigned (Unrestricted also works).
Change directory (cd) into the PineSAM folder that was extracted above.
.\\setup-dev.bat # only need to run this one time for each new version\n.\\run-dev.bat # run this command every time to start PineSAM (do not need to run as admin)\n
possible reason: pinecil is paired to computer/phone settings. solution: unpair it from all other places and reboot.
possible reason: using older firmware (below 2.21). solution: flash current BLE firmware; below IronOS 2.21 only beta versions work with PineSAM.
bleak causes Python to crash on Mac: https://github.com/hbldh/bleak/issues/768
possible solution: give access to iTerm (or whichever terminal you use) to Bluetooth in Settings
Pinecil script terminal crashes on start of script: incompatible version of IronOS, check/update firmware see .
Windows Powershell issue
windows by default does not allow any scripts to run in powershell. Make sure the zip file property is Unblock (reference) and set powershell to remotesigned with: set-executionpolicy remotesigned
check that windows has not reset the permissions in powershell with Get-ExecutionPolicy and change it back to RemoteSigned if needed (reference).
See the Discussions section for install hints, screenshot images, and solutions to common issues.
Something else: open an issue .
"},{"location":"install-guide/troubleshooting/#running-unit-tests","title":"Running Unit tests","text":"
Debug is a special category in Pinecil that is usually hidden and not used unless tracing an issue.
On Pinecil, the debug menu is accessed by long hold - and then using the + to scroll through the values.
PineSAM currently displays the raw values as sent by the Pinecil and does no change to the values; therefore, these may not match exactly what you see on the Pinecil Debug screen.
Not all values are available yet; go to Pinecil directly to see all items.
Complete Debug functions are detailed in Ralim's IronOS here.
Toggles on/off to display help messages from Pinecil and PineSAM.
"},{"location":"user-guide/usage/#save-to-flash","title":"Save to Flash","text":"
Save changes to flash should be Off most of the time. Not needed if actively soldering and using the Work HUD to change temperature (preserves flash cycles).
Toggle this On only before changing settings and if you want the settings to persist on Pinecil reboot. This saves/flashes to the BL706 MCU chip.
Change multiple settings and when done, toggle it back Off.
While actively soldering and using buttons in the Work HUD, it is best to leave the save toggle off. No reason to constantly flash to pinecil for each temperature change (don't worry, Pinecil still changes temperature, it's just not permanently flashed and saved on Pinecil).
This window designed as an all-in-one single view that can be used during soldering.
Phone use: designed to be completely viewable on vertical screen.
Control set temperature with buttons + -.
View live temperature in large font.
Thermostat icon changes into 100 different color hues as the live temperature changes.
Power Bar: bottom bar shows the input voltage, the current estimated watts pinecil is drawing, and the highest peak watts hit during the session.
Hint: while using the Work HUD view, it is best to leave save changes to flash toggle button off. This saves on pinecil flash cycles as the PineSAM buttons are used often during a soldering session.
The settings are grouped in a similar way as seen on Pinecil (and as organized in Ralim's IronOS firmware).
Categories can be clicked to collapse and reduce screen clutter.
Setting numbers can be changed two ways: moving the slider or simply typing on the box next to the slider.
Drop-down menus are used for clarity of text choices.
Toggle choices are used for any check boxes seen on the pinecil (e.g. detailed idle).
See setting feature details in Ralim's IronOS here.
Full settings view"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#pinecil-settings-and-menus","title":"Pinecil Settings and Menus","text":"
Why focus on soldering when you can play with the settings instead? With this app you have full control over your new shiny Pinecil V2 from your computer using bluetooth.
NB: No special browser flags or BLE GATT required; works on all major OS and phones.
NB: This app needs the backend to start on a computer terminal; then the user interface runs from any browser. It CANNOT run entirely by only opening a browser like Joric's UI.
Full settings view "},{"location":"#supports","title":"Supports","text":"System MacOS Linux Windows Phones UI backend"},{"location":"#features","title":"Features","text":"
Automatically detect Pinecil V2 over BLE.
Control all settings on the device.
Save to Flash: toggle to save changes directly onto Pinecil (leave off unless actively changing settings).
Work HUD main screen has: buttons + - to change temperature, live updates, peak and live watts, input voltage.
Preset buttons allow quick change of user defined temperatures (PineSAM extra feature not available directly inside Pinecil).
Backend runs locally on all major platforms/OS while the user interface runs on your favorite browser.
Try to read the documents and search the issue tracker to find answers before posting a new issue.
Follow the template in the issue ticket and include all details requested.
Be prepared to answer questions or give additional information. Issues where the creator does not follow up to questions will be marked stale and closed.
If the documents are lacking or there is a typo, consider improving it or open an issue ticket if you are not comfortable digging into a full Github Pull Request. Translating PineSAM into different languages is another way to help.
Code contributions are welcome. Just fork the code and submit well commented and clean commits to the repository. Perform a pull pequests (pr) to the /dev branch. Check out some of the open issue tickets or propose new features. If there is no existing ticket related to the PR, then create a ticket outlining what issues are being addressed.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"},{"location":"install-guide/dev-scripts/#mac-or-linux-dev","title":"Mac or Linux dev","text":""},{"location":"install-guide/dev-scripts/#setup","title":"Setup","text":"
First, install all packages linked above in dependencies.
Follow the additional hints below to install all packages linked above in dependencies.
Python install notes
Check \"Add python.exe to PATH\" and select \"Customize Installation\"
Check \"Add Python to environment variables\" option
Screenshots of options to select are here.
Install NodeJS here, accept all prompts to add packages during install including a prompt in the terminal that opens.
After installing packages listed for backend script (reference), go to System Environment variables to check paths (image).
Download the Source-all-__.zip from the latest releases.
Right-click the zip > properties, if it has an Unblock option, then unblock and extract it (example).
Run powershell as administrator, set permissions to RemoteSigned (reference). Setting this one time in powershell is usually enough as it persists on reboot.
C:\\> Set-ExecutionPolicy RemoteSigned\n
Then check that powershell permissions are correct; at minimum, need LocalMachine to show as RemoteSigned (Unrestricted also works).
Change directory (cd) into the PineSAM folder that was extracted above.
.\\setup-dev.bat # only need to run this one time for each new version\n.\\run-dev.bat # run this command every time to start PineSAM (do not need to run as admin)\n
possible reason: pinecil is paired to computer/phone settings. solution: unpair it from all other places and reboot.
possible reason: using older firmware (below 2.21). solution: flash current BLE firmware; below IronOS 2.21 only beta versions work with PineSAM.
bleak causes Python to crash on Mac: https://github.com/hbldh/bleak/issues/768
possible solution: give access to iTerm (or whichever terminal you use) to Bluetooth in Settings
Pinecil script terminal crashes on start of script: incompatible version of IronOS, check/update firmware see .
Windows Powershell issue
windows by default does not allow any scripts to run in powershell. Make sure the zip file property is Unblock (reference) and set powershell to remotesigned with: set-executionpolicy remotesigned
check that windows has not reset the permissions in powershell with Get-ExecutionPolicy and change it back to RemoteSigned if needed (reference).
See the Discussions section for install hints, screenshot images, and solutions to common issues.
Something else: open an issue .
"},{"location":"install-guide/troubleshooting/#running-unit-tests","title":"Running Unit tests","text":"
Debug is a special category in Pinecil that is usually hidden and not used unless tracing an issue.
On Pinecil, the debug menu is accessed by long hold - and then using the + to scroll through the values.
PineSAM currently displays the raw values as sent by the Pinecil and does no change to the values; therefore, these may not match exactly what you see on the Pinecil Debug screen.
Not all values are available yet; go to Pinecil directly to see all items.
Complete Debug functions are detailed in Ralim's IronOS here.
Toggles on/off to display help messages from Pinecil and PineSAM.
"},{"location":"user-guide/usage/#save-to-flash","title":"Save to Flash","text":"
Save changes to flash should be Off most of the time. Not needed if actively soldering and using the Work HUD to change temperature (preserves flash cycles).
Toggle this On only before changing settings and if you want the settings to persist on Pinecil reboot. This saves/flashes to the BL706 MCU chip.
Change multiple settings and when done, toggle it back Off.
While actively soldering and using buttons in the Work HUD, it is best to leave the save toggle off. No reason to constantly flash to pinecil for each temperature change (don't worry, Pinecil still changes temperature, it's just not permanently flashed and saved on Pinecil).
This window designed as an all-in-one single view that can be used during soldering.
Phone use: designed to be completely viewable on vertical screen.
Control set temperature with buttons + -.
View live temperature in large font.
Thermostat icon changes into 100 different color hues as the live temperature changes.
Power Bar: bottom bar shows the input voltage, the current estimated watts pinecil is drawing, and the highest peak watts hit during the session.
Hint: while using the Work HUD view, it is best to leave save changes to flash toggle button off. This saves on pinecil flash cycles as the PineSAM buttons are used often during a soldering session.
