sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-25 16:07:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

changes to frozen

Browse Source
This commit is contained in:
gijsio
2020-08-06 11:55:42 +02:00
parent e7b4c294f8
commit 6692de9e80
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
content/advance/frozen.md
View File

@@ -5,24 +5,21 @@ In this section, we discuss the usage of so called `Frozen` code. This is only u
What we call `Frozen` code, relates to a principle in MicroPython where you can include specific codeblocks or python module inside the firmware, such that you do not have to manually upload them. This can be very useful if you have a specific section of code you want to include on all your devices, without manually uploading it every time and risk losing it when formatting the file system.
## How To use the Frozen section
1. Download the (latest) source code from our [Github Repository](https://github.com/pycom/pycom-micropython-sigfox) and extract the archive, or use the GitHub desktop tool.
2. Inside the folder `pycom-micropython-sigfox/esp32/frozen` you will find the `frozen` section. We already have frozen some of the python modules into the firmware, such as `sqnsupgrade.py` and `OTA.py`.
3. In here, you can also find `_main.py` and `_boot.py` files under `Base`. These are alternative `main.py` and `boot.py` files you can build into the source code, and they will run like you would expect.
> Note that if you add anything in the `_boot.py`, it will also run in safeboot mode, and you can only change it by reflashing the firmware.
## How To use the Frozen section (Without Pybytes)
1. Download the (latest) source code from our [Github Repository](https://github.com/pycom/pycom-micropython-sigfox) and extract the archive, or use the GitHub desktop tool. If you have never build firmware from the sourcecode before, you can find the setup guide on GitHub as well.
> The code already in `_boot.py` is pretty important to make the REPL show up, do not remove that
>```python
>import os
>from machine import UART
>os.dupterm(UART(0, 115200))
>```
4. For example add to the `_main.py`:
2. Inside the folder `pycom-micropython-sigfox/esp32/frozen` you will find the `frozen` section. We already have frozen some of the python modules into the firmware, such as `sqnsupgrade.py` and `OTA.py`.
3. In here, you can find the `_main.py` and `_boot.py` files in the `frozen/Base/` folder. These are similar to `main.py` and `boot.py` files you can build into the source code, with the exception that `_boot.py` will also run in safeboot mode. Moreover can only change the behaviour by rebuilding and reflashing the firmware.
> Note that if you add anything in the `_boot.py`, keep the code already in the boot file, as that enables the output to REPL.
> When building firmware with `VARIANT=PYBYTES`, you can find the `_boot.py` and `_main.py` in the `frozen/Pybytes/` folder and the files in `Base` will **NOT** be used
4. For example, add to the `_main.py`:
```python
# _main.py
print("Hello from _main.py")
```
5. Now rebuild and reflashing the firmware. After reboot, the line will be printed in the REPL
5. Now rebuild and reflash the firmware. After reboot, the line will be printed in the REPL.
6. You can also add files to the `Custom` folder, in this example, we make a `Block.py` with the following code:
```python
# block.py
@@ -34,4 +31,6 @@ What we call `Frozen` code, relates to a principle in MicroPython where you can
>>> from block import Block
>>> Block()
My Frozen codeblock
```
```
This concludes the section about Frozen code. You should now be able to include Frozen python code inside the firmware.