Flipper Zero Unleashed Firmware
Go to file
Samuel Stauffer aa2ecbe80f
infrared: add Kaseikyo IR protocol (#1965)
* infrared: add Kaseikyo IR protocol

Add Kaseikyo IR protocol support. This protocol is also called the Panasonic protocol and is used by a number of manufacturers including Denon.

The protocol includes a vendor field and a number of fields that are vendor specific. To support the format of address+command used by flipper the vendor+genre1+genre2+id fields are encoded into the address while the data is used for the command.

There are older versions of the protocol that used a reverse bit order that are not supported.

Protocol information:
- https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_Kaseikyo.hpp
- http://www.hifi-remote.com/johnsfine/DecodeIR.html#Kaseikyo
- https://www.denon.com/-/media/files/documentmaster/denonna/avr-x3700h_avc-x3700h_ir_code_v01_04062020.doc

* Format and add unit test to Kaseikyo IR codec.

Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>
2022-11-07 18:38:04 +04:00
.github fixed job name, renamed compile step id (#1952) 2022-11-03 00:21:43 +09:00
.vscode fbt, docs: typo fixes; vscode: fixed deprecated target names (#1926) 2022-10-27 00:18:06 +09:00
applications infrared: add Kaseikyo IR protocol (#1965) 2022-11-07 18:38:04 +04:00
applications_user [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
assets infrared: add Kaseikyo IR protocol (#1965) 2022-11-07 18:38:04 +04:00
debug fbt: fixes for ufbt pt3 (#1970) 2022-11-05 20:47:59 +09:00
documentation [FL-2911] IR Universal Audio Remote (#1942) 2022-10-29 01:43:54 +09:00
firmware Code cleanup: srand, PVS warnings (#1974) 2022-11-05 18:07:24 +03:00
furi Code cleanup: srand, PVS warnings (#1974) 2022-11-05 18:07:24 +03:00
lib infrared: add Kaseikyo IR protocol (#1965) 2022-11-07 18:38:04 +04:00
scripts fbt: fixes for ufbt pt3 (#1970) 2022-11-05 20:47:59 +09:00
site_scons fbt: fix for launch_app (#1978) 2022-11-06 17:39:50 +10:00
.clang-format [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
.editorconfig Create .editorconfig (#889) 2021-12-15 14:33:52 +03:00
.gitattributes [FL-2554] Embedded arm-none-eabi toolchain (#1351) 2022-07-15 01:24:26 +09:00
.gitignore fbt: fixed include paths; added PVS-Studio configuration (#1615) 2022-08-23 02:06:17 +09:00
.gitmodules fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
.pvsconfig fbt: fixed include paths; added PVS-Studio configuration (#1615) 2022-08-23 02:06:17 +09:00
.pvsoptions Amap and PVS Studio reports in CI/CD (#1526) 2022-08-23 20:29:26 +09:00
Brewfile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CONTRIBUTING.md Naming and coding style convention, new linter tool. (#945) 2022-01-05 19:10:18 +03:00
fbt fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
fbt_options.py fbt: fixes for ufbt pt3 (#1970) 2022-11-05 20:47:59 +09:00
fbt.cmd fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
firmware.scons fbt: fixes for ufbt pt3 (#1970) 2022-11-05 20:47:59 +09:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
Makefile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
ReadMe.md Update ReadMe.md (#1766) 2022-09-24 19:36:11 +09:00
RoadMap.md Fixed README formatting & outdated information (#1123) 2022-04-15 21:26:23 +04:00
SConstruct fbt: fixes for ufbt pt3 (#1970) 2022-11-05 20:47:59 +09:00

Flipper Zero Firmware

Discord

Show me the code

Welcome to Flipper Zero's Firmware repo! Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.

Clone the Repository

You should clone with

$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git

Read the Docs

Check out details on how to build firmware, write applications, un-brick your device and more in documentation folder.

Update firmware

Get Latest Firmware from Update Server

Flipper Zero's firmware consists of two components:

  • Core2 firmware set - proprietary components by ST: FUS + radio stack. FUS is flashed at factory, and you should never update it.
  • Core1 Firmware - HAL + OS + Drivers + Applications.

They both must be flashed in the order described.

With offline update package

With Flipper attached over USB:

./fbt flash_usb

Just building the package:

./fbt updater_package

To update, copy the resulting directory to Flipper's SD card and navigate to update.fuf file in Archive app.

Core1 Firmware

Prerequisites:

One-liner: ./fbt firmware_flash

With USB DFU

  1. Download latest Firmware

  2. Reboot Flipper to Bootloader

  • Press and hold ← Left + ↩ Back for reset
  • Release ↩ Back and keep holding ← Left until blue LED lights up
  • Release ← Left
  1. Run dfu-util -D full.dfu -a 0

Build on Linux/macOS

Check out documentation/fbt.md for details on building and flashing firmware.

macOS Prerequisites

Make sure you have brew and install all the dependencies:

brew bundle --verbose

Linux Prerequisites

The FBT tool handles everything, only git is required.

Optional dependencies

  • openocd (debugging/flashing over SWD)
  • heatshrink (compiling image assets)
  • clang-format (code formatting)
  • dfu-util (flashing over USB DFU)
  • protobuf (compiling proto sources)

For example, to install them on Debian, use:

apt update
apt install openocd clang-format-13 dfu-util protobuf-compiler

heatshrink has to be compiled from sources.

Compile everything

./fbt

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

Flash everything

Connect your device via ST-Link and run:

./fbt firmware_flash

Links

Project structure

  • applications - Applications and services used in firmware
  • assets - Assets used by applications and services
  • furi - Furi Core: os level primitives and helpers
  • debug - Debug tool: GDB-plugins, SVD-file and etc
  • documentation - Documentation generation system configs and input files
  • firmware - Firmware source code
  • lib - Our and 3rd party libraries, drivers, etc.
  • scripts - Supplementary scripts and python libraries home

Also pay attention to ReadMe.md files inside those directories.