From 9627e9b5b0b5e4b5baa75117e3d8be97a8a4f88b Mon Sep 17 00:00:00 2001 From: coreglitch Date: Thu, 3 Sep 2020 10:55:28 +0600 Subject: [PATCH] Devblog (#83) * add first devblog post * add release link * add devblog to sidebar --- README.md | 55 ++++++++---------------- wiki/_Sidebar.md | 2 + wiki/devblog/Developer-blog.md | 2 + wiki/devblog/First-update-of-phase-1.md | 0 wiki/devblog/Initial-state-of-project.md | 51 ++++++++++++++++++++++ wiki_static/hw-F1B1C0.0.jpg | 3 ++ 6 files changed, 75 insertions(+), 38 deletions(-) create mode 100644 wiki/devblog/Developer-blog.md create mode 100644 wiki/devblog/First-update-of-phase-1.md create mode 100644 wiki/devblog/Initial-state-of-project.md create mode 100644 wiki_static/hw-F1B1C0.0.jpg diff --git a/README.md b/README.md index 664df7ab..04cd340b 100644 --- a/README.md +++ b/README.md @@ -4,60 +4,39 @@ Welcome to [Flipper Zero](https://flipperzero.one/zero)'s Firmware repo! Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date. -# Current state of Flipper developement - -## Hardware - -Current Flipper Zero prototype is based on board [Version 0 (F1B1C0.0)](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware-version-F1B1C0.0) that have a lot of bugs. We have finished the next version of PCB, where these bugs are fixed, and now waiting for it its manufacturing. This new board will be used as Developer Kit for early firmware development and will be sent to developers. - -## Firmware - -During the early prototyping stages of Flipper Zero, we have used a lot of 3rd-party code, sketches, and dirty demos just as proof of concept, and didn't think too much about architecture. This code splits into many incompatible pieces of code, and some of them don’t even have an UI. This repo is cleaned from all the dirty demos and prepared for contributors, so we will start porting all the legacy code here, following the new architecture. - -Right now we are working on clean architecture and documentation for contributors. You can run firmware locally (with HAL stub). - -* `docker-compose exec dev make -C target_lo` for build -* `docker-compose exec dev target_lo/build/target_lo` for run - -Read more in [building instructions](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware#building). - -# Flipper developement roadmap - -* ~~**Phase 0** (compelete) Preparing for Kickstarter, prototyping UI, checkng hardware, prototype protocol sniffer, tag readers, etc.~~ -* **Phase 1.** (Current) Set up developing routines for massive contributors activity, architecture and documentation. Building hardware rig for remote testing. -* **Phase 2.** Start massive contributors program. Preparing Developments Kits for sending to few developers. -* **Phase 3.** Next PCB release [Version 1 (F2B0C1)](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware-version-F2B0C1.1) and sending it to more contributos. -* **Phase 4.** Release PCB based on STM32WB55RB and sending it to developers. -* **Phase 5.** Making all repositories publicly open. - -# Tasks for phase 1: (Doing right now) - -* Finalize firmware core architecture and document it for contributors onboarding. You can see progress in [Core project](https://github.com/Flipper-Zero/flipperzero-firmware-community/projects/3) -* Set up a test environment and CI. You can see progress in [Environment project](https://github.com/Flipper-Zero/flipperzero-firmware-community/projects/2) -* Create Flipper Zero software emulator with display and buttons [Task #22](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/22) -* Set up integration between wiki and issues, configure wiki generator from doc files: [Task #16](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/16) -* Finish the basic wiki pages: create feature description, UI sketches, links to related project/code, documentation for protocols/ -* Make basic code examples [Task #15](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/15) -* Transfer old code to new architecture - **We are open for changes!** You can suggest changes for any part of the code, wiki, guidelines, workflow, automation, etc. If you are deary to start, please read [contribution guide](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Contributing) about creating issue, editing wiki, improving codebase and configuring environment. +# Developer blog + +You can read project updates in our developer blog: + +**[Developer blog index](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Developer-blog)** + # Firmware **[Firmware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware)** +## Build and run: + +You can run firmware locally (with HAL stub). + +* `docker-compose exec dev make -C target_lo` for build +* `docker-compose exec dev target_lo/build/target_lo` for run + +## Architecture and components + Flipper consists of the two main parts: * Core: OS, HAL, FS, bootloader, FURI * Applications: features like RFID or Tamagotchi, and also background tasks like button debouncing and backlight control. -## UI +### UI Common UI feature (menu, screens...) at [UI page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/UI) -## Features +### Features * [Basic Features](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Basic-features) * [Sub-1 GHz radio](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Sub-1-GHz-radio) (Transceiver Based on CC1101 chip for 315/433/868 MHz) diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md index f595845d..3dbd6dcb 100644 --- a/wiki/_Sidebar.md +++ b/wiki/_Sidebar.md @@ -4,6 +4,8 @@ _Do not edit this Wiki in web-interface. Read [How to edit Wiki](Contributing#ho # [Home](Home) +# [Developer blog](Developer-blog) + # [Contributing](Contributing) * [Communication](Communication) diff --git a/wiki/devblog/Developer-blog.md b/wiki/devblog/Developer-blog.md new file mode 100644 index 00000000..9dfbf87f --- /dev/null +++ b/wiki/devblog/Developer-blog.md @@ -0,0 +1,2 @@ +* 18 aug 2020 **[Initial state of project](Initial-state-of-project)** +* 1 sep 2020 **[First update of phase 1](First-update-of-phase-1)** \ No newline at end of file diff --git a/wiki/devblog/First-update-of-phase-1.md b/wiki/devblog/First-update-of-phase-1.md new file mode 100644 index 00000000..e69de29b diff --git a/wiki/devblog/Initial-state-of-project.md b/wiki/devblog/Initial-state-of-project.md new file mode 100644 index 00000000..04fcdde5 --- /dev/null +++ b/wiki/devblog/Initial-state-of-project.md @@ -0,0 +1,51 @@ +_18 aug 2020 by @glitchcore_ + +# What is done + +## Hardware release: F1B1C0.0 + +Current Flipper Zero prototype is based on board [Version 0 (F1B1C0.0)](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware-version-F1B1C0.0) that have a lot of bugs. + +![](https://github.com/Flipper-Zero/flipperzero-firmware-community/raw/master/wiki_static/hw-F1B1C0.0.jpg) + +## Firmware + +During the early prototyping stages of Flipper Zero, we have used a lot of 3rd-party code, sketches, and dirty demos just as proof of concept, and didn't think too much about architecture. This code splits into many incompatible pieces of code, and some of them don’t even have an UI. This repo is cleaned from all the dirty demos and prepared for contributors, so we will start porting all the legacy code here, following the new architecture. + +### Release 0.1 + +**[Download release](https://github.com/Flipper-Zero/flipperzero-firmware-community/releases/tag/0.1.0)** + +You can run firmware locally (with HAL stub). + +* `docker-compose exec dev make -C target_lo` for build +* `docker-compose exec dev target_lo/build/target_lo` for run + +Read more in [building instructions](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware#building). + +# To do + +## Flipper developement roadmap + +* ~~**Phase 0** (compelete) Preparing for Kickstarter, prototyping UI, checkng hardware, prototype protocol sniffer, tag readers, etc.~~ +* **Phase 1.** (Current) Set up developing routines for massive contributors activity, architecture and documentation. Building hardware rig for remote testing. +* **Phase 2.** Start massive contributors program. Preparing Developments Kits for sending to few developers. +* **Phase 3.** Next PCB release [Version 1 (F2B0C1)](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware-version-F2B0C1.1) and sending it to more contributos. +* **Phase 4.** Release PCB based on STM32WB55RB and sending it to developers. +* **Phase 5.** Making all repositories publicly open. + +## Tasks for phase 1: (Doing right now) + +Right now we are working on clean architecture and documentation for contributors. + +* Finalize firmware core architecture and document it for contributors onboarding. You can see progress in [Core project](https://github.com/Flipper-Zero/flipperzero-firmware-community/projects/3) +* Set up a test environment and CI. You can see progress in [Environment project](https://github.com/Flipper-Zero/flipperzero-firmware-community/projects/2) +* Create Flipper Zero software emulator with display and buttons [Task #22](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/22) +* Set up integration between wiki and issues, configure wiki generator from doc files: [Task #16](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/16) +* Finish the basic wiki pages: create feature description, UI sketches, links to related project/code, documentation for protocols/ +* Make basic code examples [Task #15](https://github.com/Flipper-Zero/flipperzero-firmware-community/issues/15) +* Transfer old code to new architecture + +## Next hardware release + +We have finished the next version of PCB, where a lot of bugs are fixed, and now waiting for its manufacturing. This new board will be used as Developer Kit for early firmware development and will be sent to developers. diff --git a/wiki_static/hw-F1B1C0.0.jpg b/wiki_static/hw-F1B1C0.0.jpg new file mode 100644 index 00000000..d67532b3 --- /dev/null +++ b/wiki_static/hw-F1B1C0.0.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41e98d45f897f43110a2b881a60c6579fc65b667e4db9e9ef39074d7dae4d459 +size 168847