Skip to content

Commit 223609b

Browse files
committed
update firmware build guide
1 parent 9bf5fba commit 223609b

File tree

5 files changed

+28
-17
lines changed

5 files changed

+28
-17
lines changed

.github/workflows/pixl.js-fw.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,8 @@ jobs:
2020

2121
- name: Change Owner of Container Working Directory
2222
run: chown root:root .
23-
24-
- name: build bootloader
25-
run: cd fw && make bl RELEASE=1 BOARD=${{matrix.board}}
2623
- name: build firmware
27-
run: cd fw && make app RELEASE=1 BOARD=${{matrix.board}}
28-
- name: build ota
29-
run: cd fw/application && make ota RELEASE=1 APP_VERSION=$GITHUB_RUN_NUMBER BOARD=${{matrix.board}}
30-
- name: build all
31-
run: cd fw/application && make full RELEASE=1 APP_VERSION=$GITHUB_RUN_NUMBER BOARD=${{matrix.board}}
24+
run: cd fw && make all RELEASE=1 APP_VERSION=$GITHUB_RUN_NUMBER BOARD=${{matrix.board}}
3225
- name: upload bootloader
3326
uses: actions/upload-artifact@v3
3427
with:

docs/en/03-Build-Firmware.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,28 @@
44

55
You could download the latest develop build from Github Actions
66

7-
https://github.com/impeeza/pixl.js/actions/workflows/pixl.js-fw.yml
7+
https://github.com/solosky/pixl.js/actions
88

99

1010
## Build with customized Docker image
1111

1212
You could build the firmware using customized Docker image.
1313

1414
```
15+
# create containers
1516
docker run -it --rm solosky/nrf52-sdk:latest
17+
18+
# init repository
1619
root@b10d54636088:/builds# git clone https://github.com/solosky/pixl.js
1720
root@b10d54636088:/builds# cd pixl.js
1821
root@b10d54636088:/builds/pixl.js# git submodule update --init --recursive
19-
root@b10d54636088:/builds/pixl.js# cd fw && make all
20-
root@b10d54636088:/builds/pixl.js/fw# cd application && make full ota
22+
23+
# build LCD version
24+
root@b10d54636088:/builds/pixl.js# cd fw && make all BOARD=LCD RELEASE=1
25+
26+
# build OLED version
27+
root@b10d54636088:/builds/pixl.js# cd fw && make all BOARD=OLED RELEASE=1
28+
2129
```
2230

2331
The firmware is fw/_build/pixjs_all.hex,ota package is fw/_build/pixjs_ota_vXXXX.zip

docs/zh/03-Build-Firmware.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,27 @@
44

55
您可以从Github Actions下载最新的构建开发版本。
66

7-
https://github.com/impeeza/pixl.js/actions/workflows/pixl.js-fw.yml
7+
https://github.com/solosky/pixl.js/actions
88

99

1010
## 使用定制的Docker镜像进行构建
1111

1212
您可以使用定制的Docker镜像构建固件。
1313

1414
```
15+
# 创建容器
1516
docker run -it --rm solosky/nrf52-sdk:latest
17+
18+
# 下载代码
1619
root@b10d54636088:/builds# git clone https://github.com/solosky/pixl.js
1720
root@b10d54636088:/builds# cd pixl.js
1821
root@b10d54636088:/builds/pixl.js# git submodule update --init --recursive
19-
root@b10d54636088:/builds/pixl.js# cd fw && make all
20-
root@b10d54636088:/builds/pixl.js/fw# cd application && make full ota
22+
23+
# 构建LCD固件
24+
root@b10d54636088:/builds/pixl.js# cd fw && make all BOARD=LCD RELEASE=1
25+
26+
# 构建OLED固件
27+
root@b10d54636088:/builds/pixl.js# cd fw && make all BOARD=OLED RELEASE=1
2128
```
2229

2330
构建好的固件在 fw/_build/pixjs_all.hex,ota package is fw/_build/pixjs_ota_vXXXX.zip

fw/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
.PHONY: app bl clean
22

3-
all: bl app
3+
all: bl app ota
44

55
bl:
66
@$(MAKE) -C bootloader/
77

88
app:
99
@$(MAKE) -C application/
1010

11+
ota:
12+
@$(MAKE) -C application/ full ota
13+
1114
clean:
1215
@rm -rf _build/

fw/application/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ U8G2_ROOT := ../components/u8g2/csrc
99
CHAMELEON_ROOT :=$(COMP_DIR)/chameleon-ultra/firmware
1010

1111
APP_VERSION ?= 1
12-
RELEASE ?= 0
12+
RELEASE ?= 1
1313
BOARD ?= OLED
1414

1515
$(OUTPUT_DIRECTORY)/pixljs.out: \
@@ -300,7 +300,6 @@ SRC_FILES += \
300300
$(PROJ_DIR)/i18n/hu_HU.c \
301301
$(PROJ_DIR)/i18n/de_DE.c \
302302
$(PROJ_DIR)/i18n/fr_FR.c \
303-
$(PROJ_DIR)/i18n/hu_HU.c \
304303
$(PROJ_DIR)/i18n/ja_JP.c \
305304
$(PROJ_DIR)/i18n/nl_NL.c \
306305
$(PROJ_DIR)/i18n/pt_BR.c \
@@ -714,6 +713,7 @@ sdk_config:
714713

715714
version:
716715
@cd ../ && python3 scripts/version_gen.py
716+
@echo build: BOARD=$(BOARD) RELEASE=$(RELEASE) APP_VERSION=$(APP_VERSION)
717717

718718
settingsgen:
719719
nrfutil settings generate --family NRF52 --application $(OUTPUT_DIRECTORY)/pixljs.hex --application-version $(APP_VERSION) --bootloader-version 1 --bl-settings-version 1 $(OUTPUT_DIRECTORY)/settings.hex

0 commit comments

Comments
 (0)