From ec1ec876279e738aad7d5232ff5218fa50825081 Mon Sep 17 00:00:00 2001 From: Gordon Williams Date: Tue, 8 Oct 2024 14:10:17 +0100 Subject: [PATCH] Puck.js: Remove networking support from default build, add PUCKJS_NETWORK -> espruino_2vxx_puckjs_network.zip builds for those that need it --- .github/workflows/build.yml | 2 +- ChangeLog | 1 + boards/PUCKJS.py | 5 +- boards/PUCKJS_MINIMAL.py | 3 + boards/PUCKJS_NETWORK.py | 281 +++++++++++++++++++++++++++++ scripts/create_zip.sh | 2 +- scripts/create_zip_board.sh | 6 +- scripts/create_zip_dist_readme.txt | 6 +- scripts/create_zip_fast.sh | 1 + 9 files changed, 302 insertions(+), 5 deletions(-) create mode 100644 boards/PUCKJS_NETWORK.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 304a0dbcfe..5794658241 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -74,7 +74,7 @@ jobs: strategy: # devices to build for matrix: - board: [PUCKJS, PIXLJS, JOLTJS, MDBT42Q, BANGLEJS, BANGLEJS2, PUCKJS_MINIMAL] + board: [PUCKJS, PIXLJS, JOLTJS, MDBT42Q, BANGLEJS, BANGLEJS2, PUCKJS_MINIMAL, PUCKJS_NETWORK] # try and build for all devices even if one fails fail-fast: false steps: diff --git a/ChangeLog b/ChangeLog index c8ba17119d..0ccd267c80 100644 --- a/ChangeLog +++ b/ChangeLog @@ -28,6 +28,7 @@ STM32F4: Update stm32f4xx_ll_usb to fix over-buffered USB CDC tx after being woken from deep sleep Waveform: Add 'npin' option to allow +/- output on two pins Waveform: Add ability to play directly from Storage + Puck.js: Remove networking support from default build, add PUCKJS_NETWORK -> espruino_2vxx_puckjs_network.zip builds for those that need it 2v24 : Bangle.js2: Add 'Bangle.touchRd()', 'Bangle.touchWr()' Bangle.js2: After Bangle.showTestScreen, put Bangle.js into a hard off state (not soft off) diff --git a/boards/PUCKJS.py b/boards/PUCKJS.py index e78a510f01..639a1ac4e8 100644 --- a/boards/PUCKJS.py +++ b/boards/PUCKJS.py @@ -17,6 +17,9 @@ info = { 'name' : "Puck.js", + # See: + # PUCKJS_MINIMAL - features removed to give maximum flash storage area + # PUCKJS_NETWORK - networking features added (as of 2v25 networking is removed from Puck.js by default) 'link' : [ "https://espruino.com/Puck.js" ], 'espruino_page_link' : 'Puck.js', 'default_console' : "EV_SERIAL1", @@ -30,7 +33,7 @@ 'optimizeflags' : '-Os', 'libraries' : [ 'BLUETOOTH', - 'NET', + #'NET', 'GRAPHICS', 'CRYPTO','SHA256',#'SHA512', 'AES', diff --git a/boards/PUCKJS_MINIMAL.py b/boards/PUCKJS_MINIMAL.py index 99fd9840ea..0caa68a42f 100644 --- a/boards/PUCKJS_MINIMAL.py +++ b/boards/PUCKJS_MINIMAL.py @@ -49,8 +49,11 @@ 'DEFINES+=-DCUSTOM_GETBATTERY=jswrap_puck_getBattery', 'DEFINES+=-DNFC_DEFAULT_URL=\'"https://puck-js.com/go"\'', 'DEFINES+=-DAPP_TIMER_OP_QUEUE_SIZE=3', # Puck.js magnetometer poll + 'LDFLAGS += -nostartfiles', + 'ASFLAGS += -D__STARTUP_CLEAR_BSS -D__START=main', 'DFU_PRIVATE_KEY=targets/nrf5x_dfu/dfu_private_key.pem', 'DFU_SETTINGS=--application-version 0xff --hw-version 52 --sd-req 0x8C,0x91', + 'DEFINES+=-DESPR_PACKED_SYMPTR', # Pack builtin symbols' offset into pointer to save 2 bytes/symbol 'INCLUDE += -I$(ROOT)/libs/puckjs', 'WRAPPERSOURCES += libs/puckjs/jswrap_puck.c' ] diff --git a/boards/PUCKJS_NETWORK.py b/boards/PUCKJS_NETWORK.py new file mode 100644 index 0000000000..768201e4fa --- /dev/null +++ b/boards/PUCKJS_NETWORK.py @@ -0,0 +1,281 @@ +#!/bin/false +# This file is part of Espruino, a JavaScript interpreter for Microcontrollers +# +# Copyright (C) 2013 Gordon Williams +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# ---------------------------------------------------------------------------------------- +# This file contains information for a specific board - the available pins, and where LEDs, +# Buttons, and other in-built peripherals are. It is used to build documentation as well +# as various source and header files for Espruino. +# ---------------------------------------------------------------------------------------- + +import pinutils; + +info = { + 'name' : "Puck.js Networking", + # This is a build for Puck.js that has networking added + # but JIT and Graphics functionality removed + # (As of 2v25 Puck.js networking is removed by default) + 'boardname' : "PUCKJS", + 'link' : [ "https://espruino.com/Puck.js" ], + 'espruino_page_link' : 'Puck.js', + 'default_console' : "EV_SERIAL1", + 'default_console_tx' : "D28", + 'default_console_rx' : "D29", + 'default_console_baudrate' : "9600", + 'variables' : 2630, # How many variables are allocated for Espruino to use. RAM will be overflowed if this number is too high and code won't compile. + 'bootloader' : 1, + 'binary_name' : 'espruino_%v_puckjs_network.hex', + 'build' : { + 'optimizeflags' : '-Os', + 'libraries' : [ + 'BLUETOOTH', + 'NET', + #'GRAPHICS', + 'CRYPTO','SHA256',#'SHA512', + 'AES', + 'NFC', + 'NEOPIXEL', + #'JIT' + #'FILESYSTEM' + #'TLS' + ], + 'makefile' : [ + 'DEFINES+=-DHAL_NFC_ENGINEERING_BC_FTPAN_WORKAROUND=1', # Looks like proper production nRF52s had this issue + # 'DEFINES+=-DCONFIG_GPIO_AS_PINRESET', # reset isn't being used, so let's just have an extra IO (needed for Puck.js V2) + 'DEFINES+=-DESPR_DCDC_ENABLE', # Ensure DCDC converter is enabled + 'DEFINES += -DNEOPIXEL_SCK_PIN=22 -DNEOPIXEL_LRCK_PIN=16', # SCK pin needs defining as something unused for neopixel (HW errata means they can't be disabled) see https://github.com/espruino/Espruino/issues/2071 + 'DEFINES += -DNRF_BLE_GATT_MAX_MTU_SIZE=53 -DNRF_BLE_MAX_MTU_SIZE=53', # increase MTU from default of 23 + 'DEFINES += -DCENTRAL_LINK_COUNT=2 -DNRF_SDH_BLE_CENTRAL_LINK_COUNT=2', # allow two outgoing connections at once + 'LDFLAGS += -Xlinker --defsym=LD_APP_RAM_BASE=0x3290', # set RAM base to match MTU=53 + CENTRAL_LINK_COUNT=2 + 'DEFINES+=-DBLUETOOTH_NAME_PREFIX=\'"Puck.js"\'', + 'DEFINES+=-DCUSTOM_GETBATTERY=jswrap_puck_getBattery', + 'DEFINES+=-DNFC_DEFAULT_URL=\'"https://puck-js.com/go"\'', + 'DEFINES+=-DAPP_TIMER_OP_QUEUE_SIZE=3', # Puck.js magnetometer poll + 'LDFLAGS += -nostartfiles', + 'ASFLAGS += -D__STARTUP_CLEAR_BSS -D__START=main', + 'DFU_PRIVATE_KEY=targets/nrf5x_dfu/dfu_private_key.pem', + 'DFU_SETTINGS=--application-version 0xff --hw-version 52 --sd-req 0x8C,0x91', + 'DEFINES+=-DESPR_PACKED_SYMPTR', # Pack builtin symbols' offset into pointer to save 2 bytes/symbol + 'INCLUDE += -I$(ROOT)/libs/puckjs', + 'WRAPPERSOURCES += libs/puckjs/jswrap_puck.c' + ] + } +}; + +chip = { + 'part' : "NRF52832", + 'family' : "NRF52", + 'package' : "QFN48", + 'ram' : 64, + 'flash' : 512, + 'speed' : 64, + 'usart' : 1, + 'spi' : 1, + 'i2c' : 1, + 'adc' : 1, + 'dac' : 0, + 'saved_code' : { + 'address' : ((118 - 10) * 4096), # Bootloader takes pages 120-127, FS takes 118-119 + 'page_size' : 4096, + 'pages' : 10, + 'flash_available' : 512 - ((31 + 8 + 2 + 10)*4) # Softdevice uses 31 pages of flash, bootloader 8, FS 2, code 10. Each page is 4 kb. + }, +}; + +devices = { + 'LED1' : { 'pin' : 'D5' }, + 'LED2' : { 'pin' : 'D4' }, + 'LED3' : { 'pin' : 'D3' }, + 'IR' : { 'pin_anode' : 'D25', # on v2 this just goes to a FET + 'pin_cathode' : 'D26' # on v2 this is the powered output named 'FET' + }, + 'BTN1' : { 'pin' : 'D0', 'pinstate' : 'IN_PULLDOWN' }, + 'CAPSENSE' : { 'pin_rx' : 'D11', 'pin_tx' : 'D12' }, + 'NFC': { 'pin_a':'D9', 'pin_b':'D10' }, + #'MAG': { 'device': 'MAG3110', 'addr' : 0x0E, # v1.0 + # 'pin_pwr':'D18', + # 'pin_int':'D17', + # 'pin_sda':'D20', + # 'pin_scl':'D19' } + # V2.0 + 'MAG': { 'device': 'LIS3MDL', 'addr' : 30, # v2.0 + 'pin_pwr':'D18', + 'pin_int':'D17', + 'pin_sda':'D20', + 'pin_scl':'D19', + 'pin_drdy':'D21', + }, + 'ACCEL': { 'device': 'LSM6DS3TR', 'addr' : 106, # v2.0 +# 'pin_pwr':'D16', # can't actually power this from an IO pin due to undocumented, massive power draw on startup + 'pin_int':'D13', + 'pin_sda':'D14', + 'pin_scl':'D15' }, + 'TEMP': { 'device': 'PCT2075TP', 'addr' : 78, # v2.0 + 'pin_pwr':'D8', + 'pin_sda':'D7', + 'pin_scl':'D6' } + + # Pin D22 is used for clock when driving neopixels - as not specifying a pin seems to break things +}; + +# left-right, or top-bottom order +board_v1 = { + 'bottom' : [ 'D28', 'D29', 'D30', 'D31'], + 'right' : [ 'GND', '3V', 'D2', 'D1' ], + 'left2' : [ 'D6','D7','D8','D11','D13','D14','D16','D23','D24','D27' ], + 'right2' : [ 'D15' ], + '_title' : "Puck.js 1", + '_class' : "board_v1", + '_hide_not_on_connectors' : True, + '_notes' : { + 'D11' : "Capacitive sense. D12 is connected to this pin via a 1 MOhm resistor", + 'D28' : "If pulled up to 1 on startup, D28 and D29 become Serial1", + 'D22' : "This is used as SCK when driving Neopixels, and will output a signal when 'require('neopixel').write' is called", + 'D16' : "This is used as LRCK when driving Neopixels, and will output a signal when 'require('neopixel').write' is called" + }, + "_css" : """ +#board { + width: 800px; + height: 800px; + top: 0px; + left : 0px; + background-image: url(img/PUCKJS_.jpg); +} +#boardcontainer { + height: 900px; +} +.board_v1 #bottom { + top: 639px; + left: 291px; +} +.board_v1 #right { + top: 304px; + left: 640px; +} + +.board_v1 .bottompin { width: 46px; } +.board_v1 .rightpin { height: 51px; } +.board_v1 .pinD6 { position:absolute; left: 560px; top: 419px;} +.board_v1 .pinD7 { position:absolute; left: 548px; top: 369px;} +.board_v1 .pinD8 { position:absolute; left: 512px; top: 398px;} +.board_v1 .pinD11 { position:absolute; left: 586px; top: 236px;} +.board_v1 .pinD13 { position:absolute; left: 500px; top: 293px;} +.board_v1 .pinD14 { position:absolute; left: 523px; top: 270px;} +.board_v1 .pinD15 { position:absolute; right: -483px; top: 268px;} +.board_v1 .pinD16 { position:absolute; left: 499px; top: 244px;} +.board_v1 .pinD23 { position:absolute; left: 157px; top: 438px;} +.board_v1 .pinD24 { position:absolute; left: 157px; top: 382px;} +.board_v1 .pinD27 { position:absolute; left: 244px; top: 581px;} +.board_v1 .pinD6 .DEVICE { display:none; } +.board_v1 .pinD7 .DEVICE { display:none; } +.board_v1 .pinD8 .DEVICE { display:none; } +/* allow for D11 capsense */ +.board_v1 .pinD13 .DEVICE { display:none; } +.board_v1 .pinD14 .DEVICE { display:none; } +.board_v1 .pinD15 .DEVICE { display:none; } +"""}; +board_v2 = { + 'bottom' : [ 'D28', 'D29', 'D30', 'D31'], + 'right' : [ 'GND', '3V', 'D2', 'D1' ], + 'left2' : [ 'D11','D23','D24','D26' ], + '_title' : "Puck.js 2", + '_class' : "board_v2", + '_notes' : { + 'D11' : "Capacitive sense. D12 is connected to this pin via a 1 MOhm resistor", + 'D26' : "This is connected via a FET. If D26=1, this pin is shorted to GND, if D26=0 the pin is floating", + 'D28' : "If pulled up to 1 on startup, D28 and D29 become Serial1", + 'D22' : "This is used as SCK when driving Neopixels, and will output a signal when 'require('neopixel').write' is called", + 'D16' : "This is used as LRCK when driving Neopixels, and will output a signal when 'require('neopixel').write' is called" + }, + "_css" : """ +#board { + width: 800px; + height: 800px; + top: 0px; + left : 0px; + background-image: url(img/PUCKJS_2.jpg); +} +#boardcontainer { + height: 900px; +} +.board_v2 #bottom { + top: 655px; + left: 294px; +} +.board_v2 #right { + top: 310px; + left: 640px; +} + +.board_v2 .bottompin { width: 46px; } +.board_v2 .rightpin { height: 51px; } +.board_v2 .pinD11 { position:absolute; left: 609px; top: 264px;} +.board_v2 .pinD23 { position:absolute; left: 126px; top: 414px;} +.board_v2 .pinD24 { position:absolute; left: 126px; top: 382px;} +.board_v2 .pinD26 { position:absolute; left: 258px; top: 593px;} +.board_v2 .pinD26 .DEVICE { display:none; } +"""}; +board_lite = { + 'bottom' : [ 'D28', 'D29', 'D30', 'D31'], + 'right' : [ 'GND', '3V', 'D2', 'D1' ], + '_title' : "Puck.js Lite", + '_class' : "board_lite", + '_hide_not_on_connectors' : True, + '_notes' : { + 'D21' : "Marked RST. This is usable IO by default, but is also the nRF52 reset pin.", + 'D28' : "If pulled up to 1 on startup, D28 and D29 become Serial1", + }, + "_css" : """ +#board { + width: 800px; + height: 800px; + top: 0px; + left : 0px; + background-image: url(img/PUCKJS_LITE.jpg); +} +#boardcontainer { + height: 900px; +} +.board_lite #bottom { + top: 649px; + left: 291px; +} +.board_lite #right { + top: 298px; + left: 640px; +} + +.board_lite .bottompin { width: 46px; } +.board_lite .rightpin { height: 51px; } +"""}; + +boards = [board_v2, board_v1, board_lite]; + +def get_pins(): + pins = pinutils.generate_pins(0,31) # 32 General Purpose I/O Pins. + pinutils.findpin(pins, "PD0", True)["functions"]["XL1"]=0; + pinutils.findpin(pins, "PD1", True)["functions"]["XL2"]=0; + pinutils.findpin(pins, "PD9", True)["functions"]["NFC1"]=0; + pinutils.findpin(pins, "PD10", True)["functions"]["NFC2"]=0; + pinutils.findpin(pins, "PD2", True)["functions"]["ADC1_IN0"]=0; + pinutils.findpin(pins, "PD3", True)["functions"]["ADC1_IN1"]=0; + pinutils.findpin(pins, "PD4", True)["functions"]["ADC1_IN2"]=0; + pinutils.findpin(pins, "PD5", True)["functions"]["ADC1_IN3"]=0; + pinutils.findpin(pins, "PD28", True)["functions"]["ADC1_IN4"]=0; + pinutils.findpin(pins, "PD28", True)["functions"]["USART1_TX"]=0; + pinutils.findpin(pins, "PD29", True)["functions"]["USART1_RX"]=0; + pinutils.findpin(pins, "PD29", True)["functions"]["ADC1_IN5"]=0; + pinutils.findpin(pins, "PD30", True)["functions"]["ADC1_IN6"]=0; + pinutils.findpin(pins, "PD31", True)["functions"]["ADC1_IN7"]=0; + # everything is non-5v tolerant + for pin in pins: + if pin["name"]!="PD26": + pin["functions"]["3.3"]=0; + + #The boot/reset button will function as a reset button in normal operation. Pin reset on PD21 needs to be enabled on the nRF52832 device for this to work. + return pins diff --git a/scripts/create_zip.sh b/scripts/create_zip.sh index 2b51761396..f14e9b7bb4 100755 --- a/scripts/create_zip.sh +++ b/scripts/create_zip.sh @@ -44,7 +44,7 @@ echo ------------------------------------------------------ # The following have been removed because it's too hard to keep the build going: # STM32F3DISCOVERY OLIMEXINO_STM32 HYSTM32_32 HYSTM32_28 HYSTM32_24 RAK8211 RAK8212 RUUVITAG THINGY52 RASPBERRYPI RAK5010 # -for BOARDNAME in ESPRUINO_1V3 ESPRUINO_1V3_AT ESPRUINO_1V3_WIZ PICO_1V3 PICO_1V3_CC3000 PICO_1V3_WIZ ESPRUINOWIFI PUCKJS PUCKJS_MINIMAL PIXLJS JOLTJS BANGLEJS BANGLEJS2 MDBT42Q NUCLEOF401RE NUCLEOF411RE STM32VLDISCOVERY STM32F4DISCOVERY STM32L496GDISCOVERY MICROBIT1 MICROBIT2 ESP8266_BOARD ESP8266_4MB ESP32 SMARTIBOT +for BOARDNAME in ESPRUINO_1V3 ESPRUINO_1V3_AT ESPRUINO_1V3_WIZ PICO_1V3 PICO_1V3_CC3000 PICO_1V3_WIZ ESPRUINOWIFI PUCKJS PUCKJS_MINIMAL PUCKJS_NETWORK PIXLJS JOLTJS BANGLEJS BANGLEJS2 MDBT42Q NUCLEOF401RE NUCLEOF411RE STM32VLDISCOVERY STM32F4DISCOVERY STM32L496GDISCOVERY MICROBIT1 MICROBIT2 ESP8266_BOARD ESP8266_4MB ESP32 SMARTIBOT do scripts/create_zip_board.sh $BOARDNAME done diff --git a/scripts/create_zip_board.sh b/scripts/create_zip_board.sh index 378b236ac9..87bb37316e 100755 --- a/scripts/create_zip_board.sh +++ b/scripts/create_zip_board.sh @@ -24,7 +24,7 @@ if [ "$#" -ne 1 ]; then echo "" echo "Targets are:" echo "ESPRUINO_1V3 ESPRUINO_1V3_AT ESPRUINO_1V3_WIZ PICO_1V3 PICO_1V3_CC3000 PICO_1V3_WIZ " - echo "ESPRUINOWIFI PUCKJS PIXLJS BANGLEJS BANGLEJS2 MDBT42Q NUCLEOF401RE NUCLEOF411RE STM32VLDISCOVERY" + echo "ESPRUINOWIFI PUCKJS PUCKJS_MINIMAL PUCKJS_NETWORK PIXLJS BANGLEJS BANGLEJS2 MDBT42Q NUCLEOF401RE NUCLEOF411RE STM32VLDISCOVERY" echo "STM32F4DISCOVERY STM32L496GDISCOVERY MICROBIT2 ESP8266_BOARD ESP8266_4MB ESP32 WIO_LTE RAK5010 SMARTIBOT MICROBIT1" echo "STM32F3DISCOVERY OLIMEXINO_STM32 HYSTM32_32 HYSTM32_28 HYSTM32_24 RAK8211 RAK8212 RUUVITAG THINGY52 RASPBERRYPI" exit 255 @@ -99,6 +99,10 @@ if [ "$BOARDNAME" == "PUCKJS_MINIMAL" ]; then ESP_BINARY_NAME=`basename $ESP_BINARY_NAME .hex`.zip EXTRADEFS+=DFU_UPDATE_BUILD=1 fi +if [ "$BOARDNAME" == "PUCKJS_NETWORK" ]; then + ESP_BINARY_NAME=`basename $ESP_BINARY_NAME .hex`.zip + EXTRADEFS+=DFU_UPDATE_BUILD=1 +fi if [ "$BOARDNAME" == "PIXLJS" ]; then ESP_BINARY_NAME=`basename $ESP_BINARY_NAME .hex`.zip EXTRADEFS+=DFU_UPDATE_BUILD=1 diff --git a/scripts/create_zip_dist_readme.txt b/scripts/create_zip_dist_readme.txt index 5606c835b1..a2ed1500ec 100644 --- a/scripts/create_zip_dist_readme.txt +++ b/scripts/create_zip_dist_readme.txt @@ -41,7 +41,7 @@ espruino_#v##_wifi.bin We'd strongly suggest that you use the Web IDE to flash this. espruino_#v##_puckjs.zip - - The firmware image for Espruino Puck.js Devices + - The firmware image for Espruino Puck.js Devices (no networking) See http://www.espruino.com/Puck.js#firmware-updates for more information espruino_#v##_puckjs_minimal.zip @@ -49,6 +49,10 @@ espruino_#v##_puckjs_minimal.zip Networking, graphics and crypto are removed which frees up roughly 60kB extra Flash memory which can be used for Storage, bringing the total to 98kB. See http://www.espruino.com/Puck.js#firmware-updates for more information + +espruino_#v##_puckjs_network.zip + - The firmware image for Espruino Puck.js Devices (with networking, but not JIT or Graphics) + See http://www.espruino.com/Puck.js#firmware-updates for more information espruino_#v##_pixljs.zip - The firmware image for Espruino Pixl.js Devices diff --git a/scripts/create_zip_fast.sh b/scripts/create_zip_fast.sh index 448de9e1bd..e1142535ee 100755 --- a/scripts/create_zip_fast.sh +++ b/scripts/create_zip_fast.sh @@ -54,6 +54,7 @@ PICO_1V3_WIZ ESPRUINOWIFI PUCKJS PUCKJS_MINIMAL +PUCKJS_NETWORK PIXLJS BANGLEJS BANGLEJS2