PINE64 - User contributions [en]

PineTime Development

2021-06-23T05:13:47Z

Atc1441: /* Available firmware and projects */

== Reprogramming ==

[[PineTime devkit wiring|Wire it up]] and then [[Reprogramming the PineTime| flash something]].

== Available firmware and projects ==
{| class="wikitable"
!
! Project Homepage
! Project Source
! PineTime Implementations

|-
! FreeRTOS
|https://www.freertos.org
| https://sourceforge.net/projects/freertos/
|
{|
|[[InfiniTime]] (GitHub: [https://github.com/JF002/Pinetime JF002/Pinetime])
|-
|[https://github.com/kaythe/pinetime-os kaythe/pinetime-os]
|}

|-
! Zephyr
| https://www.zephyrproject.org
| https://github.com/zephyrproject-rtos/zephyr
|
{|
|[https://github.com/najnesnaj/pinetime-zephyr najnesnaj/pinetime-zephyr]
|-
|[https://github.com/SuperPrower/pinetime_zephyr_sample_fw SuperPrower/pinetime_zephyr_sample_fw]
|-
|[https://github.com/Dejvino/pinetime-hermes-firmware Dejvino/pinetime-hermes-firmware]
|-
|[https://github.com/endian-albin/pinetime-hypnos endian-albin/pinetime-hypnos]
|}

|-
! mynewt
| https://mynewt.apache.org/about/
| https://github.com/apache/mynewt-core
|
{|
|[https://github.com/lupyuen/pinetime-rust-mynewt lupyuen/pinetime-rust-mynewt]
|-
|[https://gitlab.com/caspermeijn/klok caspermeijn/klok]
|}

|-
! MbedOS
| https://os.mbed.com
| https://github.com/ARMmbed/mbed-os
|
{|
|[https://github.com/sethitow/mbed-pinetime sethitow/mbed-pinetime]
|-
|[https://github.com/geoffrey-vl/mbed-pinetime geoffrey.vl/mbed-pinetime]
|}

|-
! RIOT
| http://riot-os.org/
| https://github.com/RIOT-OS/RIOT/
| [https://github.com/bosmoment/PineTime-apps bosmoment/PineTime-apps]

|-
! TinyGo
| https://tinygo.org
| https://github.com/tinygo-org/tinygo
| [https://github.com/aykevl/go-smartwatch aykevl/go-smartwatch]

|-
! wasp-os (MicroPython)
| https://wasp-os.readthedocs.io/
| https://github.com/daniel-thompson/wasp-os
| [https://wasp-os.readthedocs.io/en/latest/install.html#pine64-pinetime-developer-edition WaspOS PineTime install guide]

|-
! Rust + RTFM
| https://rtfm.rs/
| [https://github.com/rtfm-rs/cortex-m-rtfm rtfm-rs/cortex-m-rtfm]
| https://github.com/dbrgn/pinetime-rtfm/

|-
! Bare Metal
|
|
{|
|https://github.com/xriss/timecake
|-
|https://github.com/Arc13/Pyrus
|}
|
{|
|[https://github.com/xriss/timecake xriss/timecake]
|-
|[https://github.com/Arc13/Pyrus Arc13/Pyrus]
|}

|-
! AdaFruit bootloader
|
| https://github.com/adafruit/Adafruit_nRF52_Bootloader
| [https://github.com/daniel-thompson/wasp-bootloader daniel-thompson/wasp-bootloader]

|-
! Useful drivers
|
| https://github.com/sethitow/mbed-pinetime
| [https://github.com/sethitow/mbed-pinetime/tree/master/drivers https://github.com/sethitow/mbed-pinetime]
|}

{| class="wikitable"
!
! Project Homepage
! Project Source
! PineTime Implementations

|-
! Gadgetbridge (Android companion app)
| https://gadgetbridge.org/
| https://codeberg.org/Freeyourgadget/Gadgetbridge
| InfiniTime support in mainline

|-
! Arduino
| https://youtu.be/4aFDjymXjOw
| https://github.com/atc1441/ATCwatch
| https://github.com/atc1441/ATCwatch

|-
! OTA Update Flasher / DaFlasher
| https://youtu.be/gUVEz-pxhgg
| https://github.com/atc1441/DaFlasherFiles
| https://github.com/atc1441/DaFlasherFiles

|-
! InfiniTime companion app for Linux
| [https://github.com/alexr4535/siglo alexr4535/siglo]
|
|

|-
! Wasp-os companion app for Linux
| [https://github.com/arteeh/wasp-companion arteeh/wasp-companion]
|
|

|-
! UI design proposal
| [https://github.com/arteeh/pinetime arteeh/pinetime]
|
|

|-
! Flashing app for Linux
| [https://github.com/arteeh/pinetime-flasher arteeh/pinetime-flasher]
|
|

|-
! Flashing app for Windows
| [https://github.com/ZephyrLabs/PinetimeFlasher ZephyrLabs/PinetimeFlasher]
|
|

|-
! ESP32 / ESP8266 SWD WebFlasher
| https://youtu.be/Iu6RoXRZxOk
| https://github.com/atc1441/ESP32_nRF52_SWD
|

|-
|}

=== Manuals ===

* [https://github.com/JF002/Pinetime InfiniTime installation]
* [https://github.com/najnesnaj/pinetime-zephyr Zephyr installation] Beginner manual which explains how to install Zephyr (by najnesnaj).
* [https://wasp-os.readthedocs.io/en/latest/ Wasp-OS installation] Full manual with install instructions and an application writer's guide.

== How to write battery friendly software? ==

The key to save battery is to enable only what you need when you need it. nRF52832 has a lot of functionalities allowing you to draw as little current as possible. Here are some tips and tricks:

* Disable / shutdown / put in sleep mode '''all devices around the MCU''' (display controller, touch controller, external memory,...).
* Disable all '''peripheral inside the MCU''' when you don't need them (SPI, TWI(I²C),...). The power management of the NRF52832 is very smart and will completely shut down (power off and disable the clock) the peripheral when the software disables it.
* Put the MCU to sleep as soon and as often as possible. If you are not using a RTOS, this is done by calling ''WFE'' (wait for event) instruction. Most of the time, RTOS implement this functionality. For example, FreeRTOS calls it the ''tickless mode'' : it puts the CPU in sleep mode when no task is planned for execution for more than a specified time, and wakes up as soon as an event is detected or when a task is ready to run.
* Do not use logging (JLink RTT, SWO, semihosting,...), it uses a lot of power.
* Ensure that the debug circuitry of the MCU is not enabled when you measuring the battery life. The debug peripheral is enabled as soon as you connect a debugger to the device, and '''is not automatically disabled''', even if you disconnect the debugger you will have to wait for the battery to go flat to disable to port. The software running in the NRF52832 cannot disable the debug peripheral. How to disable the debug circuitry:
- using ''nrfjprog --reset''
- using JLinkExe : issue the command ''writeDP 1 0''

or with OpenOCD
- issue the command ''halt''
- issue the command ''flash fillw 0x10001208 0xFFFFFF00 0x01''
- issue the command ''reset''

you can check if the debug port is enabled using the following code
DWT->CYCCNT ? "NO":"YES"
* Read [https://infocenter.nordicsemi.com/pdf/nRF52832_Rev_2_Errata_v1.1.pdf the errata sheet of the MCU] and apply workarounds if they apply to your software.

== Wishlist ==

In order to keep track of features and changes to the hardware people would like to see, check out this article: [[PineTime Hardware Wishlist]]

== Compatibility with other projects ==

Different firmware running using different bootloaders and Bluetooth stacks on the nRF52832 have different requirements on how they should be initialised and what should be placed where in the internal flash.

To keep track of what, how and why things work like they do across the different projects, check out the [[PineTime SD MCUBoot|PineTime SoftDevice and MCUBoot compatibility]] article.

== Compatibility with companions apps and Bluetooth communication ==

There are a lot of different firmware running on the Pinetime that implement different BLE APIs (time synchronization, notifications, ...). Companion apps must be able to differentiate between different firmware and forks of the same firmware. See [[PineTime Bluetooth]].

== PineTime equivalents and jailbreaking ==

This page contains a list of PineTime-like smartwatches that might be "jailbreakable" or a good source for ideas for the PineTime: [[PineTime Equivalents]]

[[Category:PineTime]]

PineTime

2020-06-17T05:18:31Z

Atc1441: Added ATCwatch Firmware and DaFlasher Video links

== Frequently asked questions ==

'''Read these first!'''

* [https://wiki.pine64.org/index.php/Frequently_asked_questions_about_the_PineTime Frequently asked questions about the devkit]
* [https://wiki.pine64.org/index.php/Reprogramming_the_PineTime Programming the PineTime]
* [https://wiki.pine64.org/index.php/Lup_Yuen_Lee_Q%26A_about_PineTime Q&A about Rust and MyNewt for PineTime by Lup Yuen Lee]

== Specifications ==
'''Dimensions:''' 37.5 x 40 x 11mm 
'''Weight:''' 38 grams 
'''IP Rating:''' IP67 (waterproof to 1 meter) 
'''Display:'''
: '''Size:''' 1.3 inches (33mm) diagonal
: '''Type:''' IPS capacitive touchscreen, RGB 65K colors
: '''Display Controller:''' ST7789
: '''Resolution:''' 240x240 pixels 
'''System on Chip:''' Nordic Semiconductor nRF52832 
'''Flash:''' 512KB with additional 4MB SPI NOR 
'''RAM:''' 64KB 
'''Bluetooth:''' 5.0 (including Bluetooth Low Energy) 
'''Sensors:''' Accelerometer, Heart rate sensor 
'''Feedback:''' Vibration motor 
'''Battery:''' 170-180mAh LiPo

== SWD Pinout ==
The devkits have exposed SWD pins for flashing and debugging.

Only a few devs have soldered to these pins, most just use friction to make contact with the programming cable.

The pinout is:

[[File:PineTime_SWD_location.jpg]]

== Driving the peripherals ==

=== Display ===

Note: The factory-default software on the PineTime does not auto-detect the display being disconnected when it has already booted. That can cause garbled output, to fix it just restart the PineTime.

The display is driven using the ST7789 display controller. Use the following pins to drive the screen:

{| class="wikitable"
|-
! PineTime pin
! ST7789 pin
|-
| LCD_SCK (P0.02)
| SPI clock
|-
| LCD_SDI (P0.03)
| SPI MOSI
|-
| LCD_RS (P0.18)
| Clock/data pin (CD)
|-
| LCD_CS (P0.25)
| Chip select
|-
| LCD_RESET (P0.26)
| Display reset
|-
| LCD_BACKLIGHT_{LOW,MID,HIGH}
| Backlight (active low)
|}

Notes:

* Chip select must be held low while driving the display. It must be high when using other SPI devices on the same bus (such as external flash storage) so that the display controller won't respond to the wrong commands.
* SPI must be used in mode 3. Mode 0 (the default) won't work.
* LCD_DISPLAY_* is used to enable the backlight. Set at least one to low to see anything on the screen.
* Use SPI at 8MHz (the fastest clock available on the nRF52832) because otherwise refreshing will be super slow.

'''References''':

[https://github.com/adafruit/Adafruit-ST7735-Library/ Adafruit ST7789 driver in cpp]

=== Battery measurement ===

Reading whether the PineTime has power attached is easy: simply read the charge indication pin (P0.12). When it is high it is running on battery, when it is low it is charging.

Reading the battery voltage is a bit harder. For that you can use the battery voltage pin on P0.31 (AIN7). The returned value is 12 bits, which means it is 0..4095. You can get the measured voltage with the following formula, assuming a reference voltage of 3.3V (this is configurable in the ADC):

adcVoltage = adcValue / (4095 / 3.3)

The measured voltage is actually half of the actual battery voltage, because the ADC is connected between a voltage divider where both resistors are 1MΩ. This can be corrected by multiplying the value:

batteryVoltage = adcValue * 2 / (4095 / 3.3)

It's often better to avoid floating point values on embedded systems and in this case there is no reason to use float at all, we can just represent the value in millivolts. Therefore the formula can be simplified to:

batteryVoltage = adcValue * 2000 / (4095 / 3.3)
batteryVoltage = adcValue * 2000 / 1241

Converting this voltage to an estimated capacity in percent requires a more complicated algorithm, because Lithium-ion batteries have a non-linear discharge curve.

=== How to write battery friendly software? ===

The key to save battery is to enable only what you need when you need it. NRF52832 has a lot of functionalities allowing you to draw as little current as possible. Here are some tips and tricks:

* Disable / shutdown / put in sleep mode '''all devices around the MCU''' (display controller, touch controller, external memory,...).
* Disable all '''peripheral inside the MCU''' when you don't need them (SPI, TWI(I²C),...). The power management of the NRF52832 is very smart and will completely shut down (power off and disable the clock) the peripheral when the software disables it.
* Put the MCU to sleep as soon and as often as possible. If you are not using a RTOS, this is done by calling ''WFE'' (wait for event) instruction. Most of the time, RTOS implement this functionality. For example, FreeRTOS calls it the ''tickless mode'' : it puts the CPU in sleep mode when no task is planned for execution for more than a specified time, and wakes up as soon as an event is detected or when a task is ready to run.
* Do not use logging (JLink RTT, SWO, semihosting,...), it uses a lot of power.
* Ensure that the debug circuitry of the MCU is not enabled when you measuring the battery life. The debug peripheral is enabled as soon as you connect a debugger to the device, and '''is not automatically disabled''', even if you disconnect the debugger you will have to wait for the battery to go flat to disable to port. The software running in the NRF52832 cannot disable the debug peripheral. How to disable the debug circuitry:
- using ''nrfjprog --reset''
- using JLinkExe : issue the command ''writeDP 1 0''

or with OpenOCD
- issue the command ''halt''
- issue the command ''flash fillw 0x10001208 0xFFFFFF00 0x01''
- issue the command ''reset''

you can check if the debug port is enabled using the following code
DWT->CYCCNT ? "NO":"YES"
* Read [https://infocenter.nordicsemi.com/pdf/nRF52832_Rev_2_Errata_v1.1.pdf the errata sheet of the MCU] and apply workarounds if they apply to your software.

=== Button ===

The button on the side of the PineTime is disabled by default. To enable it, drive the button out pin (P0.15) high.

While enabled, the button in pin (P0.13) will be high when the button is pressed, and low when it is not pressed.

=== Touch panel ===

The touch panel is controlled by a Hynitron CST816S chips. Unfortunately, there is not much information about this chip on the internet apart from the datasheet below and a [https://github.com/lupyuen/hynitron_i2c_cst0xxse/ reference driver]. This is enough to implement a basic driver, but crucial information needed to implement advanced functionalities are missing (I²C protocol and registers, timings, power modes,...).

==== Pins ====

* P0.10 : Reset
* P0.28 : Interrupt (signal to the CPU when a touch event is detected)
* P0.06 : I²C SDA
* P0.07 : I²C SCL

==== I²C ====

* Device address : 0x15
* Frequency : from 10Khz to 400Khz

'''NOTE : ''' The controller go to sleep when no event is detected. In sleep mode, the controller does not communicate on the I²C bus (it appears disconnected). So, for the communication to work, you need to tap on the screen so that the chip wakes-up.

==== Touch events ====

Touch informations are available in the 63 first registers of the controller. Remember : the device is in sleep mode when no touch event is detected. It means that you can read the register only when the touch controller detected an event. You can use the ''Interrupt'' pin to detect such event in the software.

These 63 bytes contain up to 10 touch point (X, Y, event type, pressure,...) :

{| class="wikitable"
! Byte
! Bit7
! Bit6
! Bit5
! Bit4
! Bit3
! Bit2
! Bit1
! Bit0
|-
|0
|colspan="8"|?
|-
|1
|colspan="8"|GestureID : (Gesture code ,

0x00: no gesture,

0x01: Slide down,

0x02: Slide up,

0x03: Slide left,

0x04: Slide right,

0x05: Single click,

0x0B: Double click,

0x0C: Long press)
|-
|2
|colspan="4"|?
|colspan="4"|Number of touch points
|-
|3
|colspan="2"|Event (0 = Down, 1 = Up, 2 = Contact)
|colspan="2"|?
|colspan="4"|X (MSB) coordinate
|-
|4
|colspan="8"|X (LSB) coordinate
|-
|5
|colspan="2"|?
|colspan="2"|Touch ID
|colspan="4"|Y (MSB) coordinate
|-
|6
|colspan="8"|Y (LSB) coordinate
|-
|7
|colspan="8"|Pressure (?)
|-
|8
|colspan="8"|Miscellaneous (?)
|}

Bytes 3 to 8 are repeated 10 times (10*6 + 3 = 63 bytes).

'''NOTES'''

* The touch controller seems to report only 1 touch point
* Fields X, Y, Number of touch points and touch ID are updated. The others are always 0.

==== Registers ====

The reference driver specifies some registers and value, but there is no information about them:

{| class="wikitable"

!Register
!Address
!Description
|-
|HYN_REG_INT_CNT
|0x8F
|
|-
|HYN_REG_FLOW_WORK_CNT
|0x91
|
|-
|HYN_REG_WORKMODE
|0x00
|0 = WORK, 0x40 = FACTORY
|-
|HYN_REG_CHIP_ID
|0xA3
|
|-
|HYN_REG_CHIP_ID2
|0x9F
|-
|HYN_REG_POWER_MODE
|0xA5
|0x03 = SLEEP (reset the touchpanel using the reset pin before using this register : pin_low, delay 5ms, pin_high, delay 50ms then write 3 to register 0xA5)
|-
|HYN_REG_FW_VER
|0xA6
|
|-
|HYN_REG_VENDOR_ID
|0xA8
|
|-
|HYN_REG_LCD_BUSY_NUM
|0xAB
|
|-
|HYN_REG_FACE_DEC_MODE_EN
|0xB0
|
|-
|HYN_REG_GLOVE_MODE_EN
|0xC0
|
|-
|HYN_REG_COVER_MODE_EN
|0xC1
|
|-
|HYN_REG_CHARGER_MODE_EN
|0x8B
|
|-
|HYN_REG_GESTURE_EN
|0xD0
|
|-
|HYN_REG_GESTURE_OUTPUT_ADDRESS
|0xD3
|
|-
|HYN_REG_ESD_SATURATE 0xED
|0xED
|
|}

'''WARNING : ''' <del>Writing the SLEEP command (write 0x05 in HYN_REG_POWER_MODE) seems to freeze the controller (it returns only static values) until the battery is totally drained and the whole system reset. Analysis and debugging is more than welcome!</del>

== Manual / Articles ==

* [https://github.com/najnesnaj/pinetime-zephyr Beginner manual explained how you to programs and install zephyr on PineTime Dev Kit, big thanks to najnesnaj :-)]

* [https://medium.com/swlh/sneak-peek-of-pinetime-smart-watch-and-why-its-perfect-for-teaching-iot-81b74161c159 Sneak Peek of PineTime Smart Watch… And why it’s perfect for teaching IoT]

* [https://medium.com/@ly.lee/building-a-rust-driver-for-pinetimes-touch-controller-cbc1a5d5d3e9 Building a Rust Driver for PineTime’s Touch Controller]

* [https://medium.com/@ly.lee/porting-druid-rust-widgets-to-pinetime-smart-watch-7e1d5a5d977a Porting (druid) Rust Widgets to PineTime Smart Watch]

* [https://medium.com/@ly.lee/optimising-pinetimes-display-driver-with-rust-and-mynewt-3ba269ea2f5c Optimising PineTime’s Display Driver with Rust and Mynewt]

* [https://www.zephyrproject.org/getting-started-with-zephyr-rtos-on-nordic-nrf52832-hackable/ Getting Started with Zephyr RTOS on Nordic nRF52832 hackaBLE]

* [https://blog.aegrel.ee/absniffer-cmsis-dap-sniffer.html Removing the lock and installing another firmware on the nRF52832 using CMSIS-DAP dongle on Linux]

* [https://github.com/JF002/nrf52-baseproject/wiki/Build,-program-and-debug-NRF52-project-with-JLink,-CMake-and-CLion Build, program and debug NRF52 project with JLink, CMake and CLion]

* [https://www.nrbtech.io/blog/2020/1/4/using-clion-for-nordic-nrf52-projects Using CLion for Nordic nRF52 projects]

* [https://dev.to/aaronc81/flashing-your-pinetime-using-an-st-link-and-openocd-54dd Flashing your PineTime using an ST-Link and OpenOCD]

== Development efforts ==

{| class="wikitable"
!
! Project Homepage
! Project Source
! PineTime Implementations

|-
! FreeRTOS
|https://www.freertos.org
| https://sourceforge.net/projects/freertos/
|
{|
|[https://github.com/JF002/Pinetime JF002/Pinetime]
|-
|[https://github.com/kaythe/pinetime-os kaythe/pinetime-os]
|}

|-
! Zephyr
| https://www.zephyrproject.org
| https://github.com/zephyrproject-rtos/zephyr
|
{|
|[https://github.com/najnesnaj/pinetime-zephyr najnesnaj/pinetime-zephyr]
|-
|[https://github.com/SuperPrower/pinetime_zephyr_sample_fw SuperPrower/pinetime_zephyr_sample_fw]
|-
|[https://github.com/Dejvino/pinetime-hermes-firmware Dejvino/pinetime-hermes-firmware]
|-
|[https://github.com/endian-albin/pinetime-hypnos endian-albin/pinetime-hypnos]
|}

|-
! mynewt
| https://mynewt.apache.org/about/
| https://github.com/apache/mynewt-core
| [https://github.com/lupyuen/pinetime-rust-mynewt lupyuen/pinetime-rust-mynewt]

|-
! MbedOS
| https://os.mbed.com
| https://github.com/ARMmbed/mbed-os
|
{|
|[https://github.com/sethitow/awesome-pinetime sethitow/mbed-pinetime]
|-
|[https://github.com/geoffrey-vl/mbed-pinetime geoffrey.vl/mbed-pinetime]
|}

|-
! RIOT
| http://riot-os.org/
| https://github.com/RIOT-OS/RIOT/
| [https://github.com/bosmoment/PineTime-apps bosmoment/PineTime-apps]

|-
! TinyGo
| https://tinygo.org
| https://github.com/tinygo-org/tinygo
| [https://github.com/aykevl/go-smartwatch aykevl/go-smartwatch]

|-
! MicroPython
| https://micropython.org/
| https://github.com/micropython/micropython
| [https://github.com/daniel-thompson/wasp-os daniel-thompson/wasp-os]

|-
! Rust + RTFM
| https://rtfm.rs/
| [https://github.com/rtfm-rs/cortex-m-rtfm rtfm-rs/cortex-m-rtfm]
| https://github.com/dbrgn/pinetime-rtfm/

|-
! Bare Metal
|
|
{|
|https://github.com/xriss/timecake
|-
|https://github.com/Arc13/Pyrus
|}
|
{|
|[https://github.com/xriss/timecake xriss/timecake]
|-
|[https://github.com/Arc13/Pyrus Arc13/Pyrus]
|}
|-
! AdaFruit bootloader
|
| https://github.com/adafruit/Adafruit_nRF52_Bootloader
| [https://github.com/daniel-thompson/wasp-bootloader daniel-thompson/wasp-bootloader]
|-
! Useful drivers
|
| https://github.com/sethitow/mbed-pinetime
| [https://github.com/sethitow/mbed-pinetime/tree/master/drivers https://github.com/sethitow/mbed-pinetime]

|-
! UI concepts and drawings
|
|
| [https://gitlab.com/arteeh/pinetimeos arteeh/pinetimeos]
|-
! Arduino
| https://youtu.be/4aFDjymXjOw
| https://github.com/atc1441/ATCwatch
| https://github.com/atc1441/ATCwatch
|-
! OTA Update Flasher / DaFlasher
| https://youtu.be/gUVEz-pxhgg
| https://github.com/atc1441/DaFlasherFiles
| https://github.com/atc1441/DaFlasherFiles
|-
|}

== Datasheets and Schematics ==

=== Schematics ===
* [http://files.pine64.org/doc/PineTime/PineTime%20Schematic-V1.0a-20191103.pdf PineTime Schematic ver1.0a]
* [http://files.pine64.org/doc/PineTime/PineTime%20Port%20Assignment%20rev1.0.pdf PineTime GPIO Port Assignment ver1.0]

Note: The part number for the SPI FLASH in the schematic diagram is not correct, the PineTime features a larger external FLASH device, see below.

=== Chip Datasheets ===
* NORDIC nRF52832 information:
** [http://files.pine64.org/doc/datasheet/pinetime/nRF52832%20product%20brief.pdf nRF52832 Product Brief]
** [https://infocenter.nordicsemi.com/pdf/nRF52832_PS_v1.1.pdf nRF52832 Product Specification v1.1]
* ARMv7-M information:
** [https://static.docs.arm.com/ddi0403/eb/DDI0403E_B_armv7m_arm.pdf ARMv7-M Architecture Reference Manual]

=== Component Datasheets ===
* PMU (Power Management Unit) information:
** [http://files.pine64.org/doc/datasheet/pinetime/SGM40561.pdf SGMicro SGM40561 Single Cell Charger Datasheet]
** [http://files.pine64.org/doc/datasheet/pinetime/SGMICRO-SGM2036.pdf SGMicro SGM2036 3.3V Low Power Low Dropout RF Linear Regulator Datasheet]
* SPI Flash information:
** [https://www.elnec.com/en/device/XTX/XT25F32B+%28QuadSPI%29+%5BSOP8-200%5D/ XTX XT25F32B 32Mb(4MB) SPI NOR Flash] (data sheets for this part are hard to find but it acts similar to other QuadSPI SPI NOR Flash such as [https://www.macronix.com/Lists/Datasheet/Attachments/7426/MX25L3233F,%203V,%2032Mb,%20v1.6.pdf Macronix 32Mb(4MB) SPI NOR Flash])
** IDs for XT25F32B are: manufacturer (0x0b), device (0x15), memory type (0x40), density (0x16)
* LCD Panel:
** [http://files.pine64.org/doc/datasheet/pinetime/PineTime%20LCD%20Panel.jpg 1.3" 240x240 IPS LCD Panel Specification for PineTime]
** [https://wiki.pine64.org/images/5/54/ST7789V_v1.6.pdf 11.6" Sitronix LCD Driver/Controller Datasheet]
* Touchpad information:
** [http://files.pine64.org/doc/datasheet/pinetime/PineTime%20Touch%20Panel.jpg Touchpad Specification for PineTimel]
** [http://files.pine64.org/doc/datasheet/pinetime/CST816S数据手册V1.1.pdf 11.6" Hynitron CST816S Capacitive Touch Controller Datasheet in Chinese]
*** [https://wiki.pine64.org/images/5/51/CST816S%E6%95%B0%E6%8D%AE%E6%89%8B%E5%86%8CV1.1.en.pdf English Translation]
* Sensor:
** [http://files.pine64.org/doc/datasheet/pinetime/BST-BMA421-FL000.pdf BOSCH BMA421 Triaxial VAcceleration Sensor Product Brief]
** [https://wiki.pine64.org/images/c/cc/Bst-bma400-ds000.pdf BOSCH BMA400 3-axes ultra-low power accelerometer datasheet]
** [http://files.pine64.org/doc/datasheet/pinetime/HRS3300%20Heart%20Rate%20Sensor.pdf TianYiHeXin HRS3300 PPG Heart Rate Sensor Data Sheet]

= Community =
* [https://forum.pine64.org/forumdisplay.php?fid=134 PineTime forum]
* [https://riot.im/app/#/room/#pinetime64:matrix.org Matrix Channel] (No login required to read)
* IRC: Server us.pine64.xyz. Type /list to see all channels
* [https://t.me/pinetime Telegram group]
* [https://discordapp.com/invite/DgB7kzr Discord server invite link]

PineTime

2020-06-17T05:16:35Z

Atc1441: Added ATCwatch Firmware and DaFlasher

== Frequently asked questions ==

'''Read these first!'''

* [https://wiki.pine64.org/index.php/Frequently_asked_questions_about_the_PineTime Frequently asked questions about the devkit]
* [https://wiki.pine64.org/index.php/Reprogramming_the_PineTime Programming the PineTime]
* [https://wiki.pine64.org/index.php/Lup_Yuen_Lee_Q%26A_about_PineTime Q&A about Rust and MyNewt for PineTime by Lup Yuen Lee]

== Specifications ==
'''Dimensions:''' 37.5 x 40 x 11mm 
'''Weight:''' 38 grams 
'''IP Rating:''' IP67 (waterproof to 1 meter) 
'''Display:'''
: '''Size:''' 1.3 inches (33mm) diagonal
: '''Type:''' IPS capacitive touchscreen, RGB 65K colors
: '''Display Controller:''' ST7789
: '''Resolution:''' 240x240 pixels 
'''System on Chip:''' Nordic Semiconductor nRF52832 
'''Flash:''' 512KB with additional 4MB SPI NOR 
'''RAM:''' 64KB 
'''Bluetooth:''' 5.0 (including Bluetooth Low Energy) 
'''Sensors:''' Accelerometer, Heart rate sensor 
'''Feedback:''' Vibration motor 
'''Battery:''' 170-180mAh LiPo

== SWD Pinout ==
The devkits have exposed SWD pins for flashing and debugging.

Only a few devs have soldered to these pins, most just use friction to make contact with the programming cable.

The pinout is:

[[File:PineTime_SWD_location.jpg]]

== Driving the peripherals ==

=== Display ===

Note: The factory-default software on the PineTime does not auto-detect the display being disconnected when it has already booted. That can cause garbled output, to fix it just restart the PineTime.

The display is driven using the ST7789 display controller. Use the following pins to drive the screen:

{| class="wikitable"
|-
! PineTime pin
! ST7789 pin
|-
| LCD_SCK (P0.02)
| SPI clock
|-
| LCD_SDI (P0.03)
| SPI MOSI
|-
| LCD_RS (P0.18)
| Clock/data pin (CD)
|-
| LCD_CS (P0.25)
| Chip select
|-
| LCD_RESET (P0.26)
| Display reset
|-
| LCD_BACKLIGHT_{LOW,MID,HIGH}
| Backlight (active low)
|}

Notes:

* Chip select must be held low while driving the display. It must be high when using other SPI devices on the same bus (such as external flash storage) so that the display controller won't respond to the wrong commands.
* SPI must be used in mode 3. Mode 0 (the default) won't work.
* LCD_DISPLAY_* is used to enable the backlight. Set at least one to low to see anything on the screen.
* Use SPI at 8MHz (the fastest clock available on the nRF52832) because otherwise refreshing will be super slow.

'''References''':

[https://github.com/adafruit/Adafruit-ST7735-Library/ Adafruit ST7789 driver in cpp]

=== Battery measurement ===

Reading whether the PineTime has power attached is easy: simply read the charge indication pin (P0.12). When it is high it is running on battery, when it is low it is charging.

Reading the battery voltage is a bit harder. For that you can use the battery voltage pin on P0.31 (AIN7). The returned value is 12 bits, which means it is 0..4095. You can get the measured voltage with the following formula, assuming a reference voltage of 3.3V (this is configurable in the ADC):

adcVoltage = adcValue / (4095 / 3.3)

The measured voltage is actually half of the actual battery voltage, because the ADC is connected between a voltage divider where both resistors are 1MΩ. This can be corrected by multiplying the value:

batteryVoltage = adcValue * 2 / (4095 / 3.3)

It's often better to avoid floating point values on embedded systems and in this case there is no reason to use float at all, we can just represent the value in millivolts. Therefore the formula can be simplified to:

batteryVoltage = adcValue * 2000 / (4095 / 3.3)
batteryVoltage = adcValue * 2000 / 1241

Converting this voltage to an estimated capacity in percent requires a more complicated algorithm, because Lithium-ion batteries have a non-linear discharge curve.

=== How to write battery friendly software? ===

The key to save battery is to enable only what you need when you need it. NRF52832 has a lot of functionalities allowing you to draw as little current as possible. Here are some tips and tricks:

* Disable / shutdown / put in sleep mode '''all devices around the MCU''' (display controller, touch controller, external memory,...).
* Disable all '''peripheral inside the MCU''' when you don't need them (SPI, TWI(I²C),...). The power management of the NRF52832 is very smart and will completely shut down (power off and disable the clock) the peripheral when the software disables it.
* Put the MCU to sleep as soon and as often as possible. If you are not using a RTOS, this is done by calling ''WFE'' (wait for event) instruction. Most of the time, RTOS implement this functionality. For example, FreeRTOS calls it the ''tickless mode'' : it puts the CPU in sleep mode when no task is planned for execution for more than a specified time, and wakes up as soon as an event is detected or when a task is ready to run.
* Do not use logging (JLink RTT, SWO, semihosting,...), it uses a lot of power.
* Ensure that the debug circuitry of the MCU is not enabled when you measuring the battery life. The debug peripheral is enabled as soon as you connect a debugger to the device, and '''is not automatically disabled''', even if you disconnect the debugger you will have to wait for the battery to go flat to disable to port. The software running in the NRF52832 cannot disable the debug peripheral. How to disable the debug circuitry:
- using ''nrfjprog --reset''
- using JLinkExe : issue the command ''writeDP 1 0''

or with OpenOCD
- issue the command ''halt''
- issue the command ''flash fillw 0x10001208 0xFFFFFF00 0x01''
- issue the command ''reset''

you can check if the debug port is enabled using the following code
DWT->CYCCNT ? "NO":"YES"
* Read [https://infocenter.nordicsemi.com/pdf/nRF52832_Rev_2_Errata_v1.1.pdf the errata sheet of the MCU] and apply workarounds if they apply to your software.

=== Button ===

The button on the side of the PineTime is disabled by default. To enable it, drive the button out pin (P0.15) high.

While enabled, the button in pin (P0.13) will be high when the button is pressed, and low when it is not pressed.

=== Touch panel ===

The touch panel is controlled by a Hynitron CST816S chips. Unfortunately, there is not much information about this chip on the internet apart from the datasheet below and a [https://github.com/lupyuen/hynitron_i2c_cst0xxse/ reference driver]. This is enough to implement a basic driver, but crucial information needed to implement advanced functionalities are missing (I²C protocol and registers, timings, power modes,...).

==== Pins ====

* P0.10 : Reset
* P0.28 : Interrupt (signal to the CPU when a touch event is detected)
* P0.06 : I²C SDA
* P0.07 : I²C SCL

==== I²C ====

* Device address : 0x15
* Frequency : from 10Khz to 400Khz

'''NOTE : ''' The controller go to sleep when no event is detected. In sleep mode, the controller does not communicate on the I²C bus (it appears disconnected). So, for the communication to work, you need to tap on the screen so that the chip wakes-up.

==== Touch events ====

Touch informations are available in the 63 first registers of the controller. Remember : the device is in sleep mode when no touch event is detected. It means that you can read the register only when the touch controller detected an event. You can use the ''Interrupt'' pin to detect such event in the software.

These 63 bytes contain up to 10 touch point (X, Y, event type, pressure,...) :

{| class="wikitable"
! Byte
! Bit7
! Bit6
! Bit5
! Bit4
! Bit3
! Bit2
! Bit1
! Bit0
|-
|0
|colspan="8"|?
|-
|1
|colspan="8"|GestureID : (Gesture code ,

0x00: no gesture,

0x01: Slide down,

0x02: Slide up,

0x03: Slide left,

0x04: Slide right,

0x05: Single click,

0x0B: Double click,

0x0C: Long press)
|-
|2
|colspan="4"|?
|colspan="4"|Number of touch points
|-
|3
|colspan="2"|Event (0 = Down, 1 = Up, 2 = Contact)
|colspan="2"|?
|colspan="4"|X (MSB) coordinate
|-
|4
|colspan="8"|X (LSB) coordinate
|-
|5
|colspan="2"|?
|colspan="2"|Touch ID
|colspan="4"|Y (MSB) coordinate
|-
|6
|colspan="8"|Y (LSB) coordinate
|-
|7
|colspan="8"|Pressure (?)
|-
|8
|colspan="8"|Miscellaneous (?)
|}

Bytes 3 to 8 are repeated 10 times (10*6 + 3 = 63 bytes).

'''NOTES'''

* The touch controller seems to report only 1 touch point
* Fields X, Y, Number of touch points and touch ID are updated. The others are always 0.

==== Registers ====

The reference driver specifies some registers and value, but there is no information about them:

{| class="wikitable"

!Register
!Address
!Description
|-
|HYN_REG_INT_CNT
|0x8F
|
|-
|HYN_REG_FLOW_WORK_CNT
|0x91
|
|-
|HYN_REG_WORKMODE
|0x00
|0 = WORK, 0x40 = FACTORY
|-
|HYN_REG_CHIP_ID
|0xA3
|
|-
|HYN_REG_CHIP_ID2
|0x9F
|-
|HYN_REG_POWER_MODE
|0xA5
|0x03 = SLEEP (reset the touchpanel using the reset pin before using this register : pin_low, delay 5ms, pin_high, delay 50ms then write 3 to register 0xA5)
|-
|HYN_REG_FW_VER
|0xA6
|
|-
|HYN_REG_VENDOR_ID
|0xA8
|
|-
|HYN_REG_LCD_BUSY_NUM
|0xAB
|
|-
|HYN_REG_FACE_DEC_MODE_EN
|0xB0
|
|-
|HYN_REG_GLOVE_MODE_EN
|0xC0
|
|-
|HYN_REG_COVER_MODE_EN
|0xC1
|
|-
|HYN_REG_CHARGER_MODE_EN
|0x8B
|
|-
|HYN_REG_GESTURE_EN
|0xD0
|
|-
|HYN_REG_GESTURE_OUTPUT_ADDRESS
|0xD3
|
|-
|HYN_REG_ESD_SATURATE 0xED
|0xED
|
|}

'''WARNING : ''' <del>Writing the SLEEP command (write 0x05 in HYN_REG_POWER_MODE) seems to freeze the controller (it returns only static values) until the battery is totally drained and the whole system reset. Analysis and debugging is more than welcome!</del>

== Manual / Articles ==

* [https://github.com/najnesnaj/pinetime-zephyr Beginner manual explained how you to programs and install zephyr on PineTime Dev Kit, big thanks to najnesnaj :-)]

* [https://medium.com/swlh/sneak-peek-of-pinetime-smart-watch-and-why-its-perfect-for-teaching-iot-81b74161c159 Sneak Peek of PineTime Smart Watch… And why it’s perfect for teaching IoT]

* [https://medium.com/@ly.lee/building-a-rust-driver-for-pinetimes-touch-controller-cbc1a5d5d3e9 Building a Rust Driver for PineTime’s Touch Controller]

* [https://medium.com/@ly.lee/porting-druid-rust-widgets-to-pinetime-smart-watch-7e1d5a5d977a Porting (druid) Rust Widgets to PineTime Smart Watch]

* [https://medium.com/@ly.lee/optimising-pinetimes-display-driver-with-rust-and-mynewt-3ba269ea2f5c Optimising PineTime’s Display Driver with Rust and Mynewt]

* [https://www.zephyrproject.org/getting-started-with-zephyr-rtos-on-nordic-nrf52832-hackable/ Getting Started with Zephyr RTOS on Nordic nRF52832 hackaBLE]

* [https://blog.aegrel.ee/absniffer-cmsis-dap-sniffer.html Removing the lock and installing another firmware on the nRF52832 using CMSIS-DAP dongle on Linux]

* [https://github.com/JF002/nrf52-baseproject/wiki/Build,-program-and-debug-NRF52-project-with-JLink,-CMake-and-CLion Build, program and debug NRF52 project with JLink, CMake and CLion]

* [https://www.nrbtech.io/blog/2020/1/4/using-clion-for-nordic-nrf52-projects Using CLion for Nordic nRF52 projects]

* [https://dev.to/aaronc81/flashing-your-pinetime-using-an-st-link-and-openocd-54dd Flashing your PineTime using an ST-Link and OpenOCD]

== Development efforts ==

{| class="wikitable"
!
! Project Homepage
! Project Source
! PineTime Implementations

|-
! FreeRTOS
|https://www.freertos.org
| https://sourceforge.net/projects/freertos/
|
{|
|[https://github.com/JF002/Pinetime JF002/Pinetime]
|-
|[https://github.com/kaythe/pinetime-os kaythe/pinetime-os]
|}

|-
! Zephyr
| https://www.zephyrproject.org
| https://github.com/zephyrproject-rtos/zephyr
|
{|
|[https://github.com/najnesnaj/pinetime-zephyr najnesnaj/pinetime-zephyr]
|-
|[https://github.com/SuperPrower/pinetime_zephyr_sample_fw SuperPrower/pinetime_zephyr_sample_fw]
|-
|[https://github.com/Dejvino/pinetime-hermes-firmware Dejvino/pinetime-hermes-firmware]
|-
|[https://github.com/endian-albin/pinetime-hypnos endian-albin/pinetime-hypnos]
|}

|-
! mynewt
| https://mynewt.apache.org/about/
| https://github.com/apache/mynewt-core
| [https://github.com/lupyuen/pinetime-rust-mynewt lupyuen/pinetime-rust-mynewt]

|-
! MbedOS
| https://os.mbed.com
| https://github.com/ARMmbed/mbed-os
|
{|
|[https://github.com/sethitow/awesome-pinetime sethitow/mbed-pinetime]
|-
|[https://github.com/geoffrey-vl/mbed-pinetime geoffrey.vl/mbed-pinetime]
|}

|-
! RIOT
| http://riot-os.org/
| https://github.com/RIOT-OS/RIOT/
| [https://github.com/bosmoment/PineTime-apps bosmoment/PineTime-apps]

|-
! TinyGo
| https://tinygo.org
| https://github.com/tinygo-org/tinygo
| [https://github.com/aykevl/go-smartwatch aykevl/go-smartwatch]

|-
! MicroPython
| https://micropython.org/
| https://github.com/micropython/micropython
| [https://github.com/daniel-thompson/wasp-os daniel-thompson/wasp-os]

|-
! Rust + RTFM
| https://rtfm.rs/
| [https://github.com/rtfm-rs/cortex-m-rtfm rtfm-rs/cortex-m-rtfm]
| https://github.com/dbrgn/pinetime-rtfm/

|-
! Bare Metal
|
|
{|
|https://github.com/xriss/timecake
|-
|https://github.com/Arc13/Pyrus
|}
|
{|
|[https://github.com/xriss/timecake xriss/timecake]
|-
|[https://github.com/Arc13/Pyrus Arc13/Pyrus]
|}
|-
! AdaFruit bootloader
|
| https://github.com/adafruit/Adafruit_nRF52_Bootloader
| [https://github.com/daniel-thompson/wasp-bootloader daniel-thompson/wasp-bootloader]
|-
! Useful drivers
|
| https://github.com/sethitow/mbed-pinetime
| [https://github.com/sethitow/mbed-pinetime/tree/master/drivers https://github.com/sethitow/mbed-pinetime]

|-
! UI concepts and drawings
|
|
| [https://gitlab.com/arteeh/pinetimeos arteeh/pinetimeos]
|-
! Arduino
|
| https://github.com/atc1441/ATCwatch
| https://github.com/atc1441/ATCwatch
|-
! OTA Update Flasher / DaFlasher
|
| https://github.com/atc1441/DaFlasherFiles
| https://github.com/atc1441/DaFlasherFiles
|-
|}

== Datasheets and Schematics ==

=== Schematics ===
* [http://files.pine64.org/doc/PineTime/PineTime%20Schematic-V1.0a-20191103.pdf PineTime Schematic ver1.0a]
* [http://files.pine64.org/doc/PineTime/PineTime%20Port%20Assignment%20rev1.0.pdf PineTime GPIO Port Assignment ver1.0]

Note: The part number for the SPI FLASH in the schematic diagram is not correct, the PineTime features a larger external FLASH device, see below.

=== Chip Datasheets ===
* NORDIC nRF52832 information:
** [http://files.pine64.org/doc/datasheet/pinetime/nRF52832%20product%20brief.pdf nRF52832 Product Brief]
** [https://infocenter.nordicsemi.com/pdf/nRF52832_PS_v1.1.pdf nRF52832 Product Specification v1.1]
* ARMv7-M information:
** [https://static.docs.arm.com/ddi0403/eb/DDI0403E_B_armv7m_arm.pdf ARMv7-M Architecture Reference Manual]

=== Component Datasheets ===
* PMU (Power Management Unit) information:
** [http://files.pine64.org/doc/datasheet/pinetime/SGM40561.pdf SGMicro SGM40561 Single Cell Charger Datasheet]
** [http://files.pine64.org/doc/datasheet/pinetime/SGMICRO-SGM2036.pdf SGMicro SGM2036 3.3V Low Power Low Dropout RF Linear Regulator Datasheet]
* SPI Flash information:
** [https://www.elnec.com/en/device/XTX/XT25F32B+%28QuadSPI%29+%5BSOP8-200%5D/ XTX XT25F32B 32Mb(4MB) SPI NOR Flash] (data sheets for this part are hard to find but it acts similar to other QuadSPI SPI NOR Flash such as [https://www.macronix.com/Lists/Datasheet/Attachments/7426/MX25L3233F,%203V,%2032Mb,%20v1.6.pdf Macronix 32Mb(4MB) SPI NOR Flash])
** IDs for XT25F32B are: manufacturer (0x0b), device (0x15), memory type (0x40), density (0x16)
* LCD Panel:
** [http://files.pine64.org/doc/datasheet/pinetime/PineTime%20LCD%20Panel.jpg 1.3" 240x240 IPS LCD Panel Specification for PineTime]
** [https://wiki.pine64.org/images/5/54/ST7789V_v1.6.pdf 11.6" Sitronix LCD Driver/Controller Datasheet]
* Touchpad information:
** [http://files.pine64.org/doc/datasheet/pinetime/PineTime%20Touch%20Panel.jpg Touchpad Specification for PineTimel]
** [http://files.pine64.org/doc/datasheet/pinetime/CST816S数据手册V1.1.pdf 11.6" Hynitron CST816S Capacitive Touch Controller Datasheet in Chinese]
*** [https://wiki.pine64.org/images/5/51/CST816S%E6%95%B0%E6%8D%AE%E6%89%8B%E5%86%8CV1.1.en.pdf English Translation]
* Sensor:
** [http://files.pine64.org/doc/datasheet/pinetime/BST-BMA421-FL000.pdf BOSCH BMA421 Triaxial VAcceleration Sensor Product Brief]
** [https://wiki.pine64.org/images/c/cc/Bst-bma400-ds000.pdf BOSCH BMA400 3-axes ultra-low power accelerometer datasheet]
** [http://files.pine64.org/doc/datasheet/pinetime/HRS3300%20Heart%20Rate%20Sensor.pdf TianYiHeXin HRS3300 PPG Heart Rate Sensor Data Sheet]

= Community =
* [https://forum.pine64.org/forumdisplay.php?fid=134 PineTime forum]
* [https://riot.im/app/#/room/#pinetime64:matrix.org Matrix Channel] (No login required to read)
* IRC: Server us.pine64.xyz. Type /list to see all channels
* [https://t.me/pinetime Telegram group]
* [https://discordapp.com/invite/DgB7kzr Discord server invite link]