[
{
"path": ".clang-format",
"content": "---\nLanguage: Cpp\nAccessModifierOffset: -4\nAlignAfterOpenBracket: AlwaysBreak\nAlignArrayOfStructures: None\nAlignConsecutiveAssignments:\n Enabled: false\n AcrossEmptyLines: false\n AcrossComments: false\n AlignCompound: false\n AlignFunctionPointers: false\n PadOperators: true\nAlignConsecutiveBitFields:\n Enabled: true\n AcrossEmptyLines: true\n AcrossComments: true\n AlignCompound: false\n AlignFunctionPointers: false\n PadOperators: true\nAlignConsecutiveDeclarations:\n Enabled: false\n AcrossEmptyLines: false\n AcrossComments: false\n AlignCompound: false\n AlignFunctionPointers: false\n PadOperators: true\nAlignConsecutiveMacros:\n Enabled: true\n AcrossEmptyLines: false\n AcrossComments: true\n AlignCompound: true\n AlignFunctionPointers: false\n PadOperators: true\nAlignConsecutiveShortCaseStatements:\n Enabled: false\n AcrossEmptyLines: false\n AcrossComments: false\n AlignCaseColons: false\nAlignEscapedNewlines: Left\nAlignOperands: Align\nAlignTrailingComments:\n Kind: Never\n OverEmptyLines: 0\nAllowAllArgumentsOnNextLine: true\nAllowAllParametersOfDeclarationOnNextLine: false\nAllowBreakBeforeNoexceptSpecifier: Never\nAllowShortBlocksOnASingleLine: Never\nAllowShortCaseLabelsOnASingleLine: false\nAllowShortCompoundRequirementOnASingleLine: true\nAllowShortEnumsOnASingleLine: false\nAllowShortFunctionsOnASingleLine: None\nAllowShortIfStatementsOnASingleLine: WithoutElse\nAllowShortLambdasOnASingleLine: All\nAllowShortLoopsOnASingleLine: false\nAlwaysBreakAfterDefinitionReturnType: None\nAlwaysBreakAfterReturnType: None\nAlwaysBreakBeforeMultilineStrings: false\nAlwaysBreakTemplateDeclarations: Yes\nAttributeMacros:\n - __capability\nBinPackArguments: false\nBinPackParameters: false\nBitFieldColonSpacing: Both\nBraceWrapping:\n AfterCaseLabel: false\n AfterClass: false\n AfterControlStatement: Never\n AfterEnum: false\n AfterExternBlock: false\n AfterFunction: false\n AfterNamespace: false\n AfterObjCDeclaration: false\n AfterStruct: false\n AfterUnion: false\n BeforeCatch: false\n BeforeElse: false\n BeforeLambdaBody: false\n BeforeWhile: false\n IndentBraces: false\n SplitEmptyFunction: true\n SplitEmptyRecord: true\n SplitEmptyNamespace: true\nBreakAdjacentStringLiterals: true\nBreakAfterAttributes: Leave\nBreakAfterJavaFieldAnnotations: false\nBreakArrays: true\nBreakBeforeBinaryOperators: None\nBreakBeforeConceptDeclarations: Always\nBreakBeforeBraces: Attach\nBreakBeforeInlineASMColon: OnlyMultiline\nBreakBeforeTernaryOperators: false\nBreakConstructorInitializers: BeforeComma\nBreakInheritanceList: BeforeColon\nBreakStringLiterals: false\nColumnLimit: 99\nCommentPragmas: '^ IWYU pragma:'\nCompactNamespaces: false\nConstructorInitializerIndentWidth: 4\nContinuationIndentWidth: 4\nCpp11BracedListStyle: true\nDerivePointerAlignment: false\nDisableFormat: false\nEmptyLineAfterAccessModifier: Never\nEmptyLineBeforeAccessModifier: LogicalBlock\nExperimentalAutoDetectBinPacking: false\nFixNamespaceComments: false\nForEachMacros:\n - foreach\n - Q_FOREACH\n - BOOST_FOREACH\n - M_EACH\nIfMacros:\n - KJ_IF_MAYBE\nIncludeBlocks: Preserve\nIncludeCategories:\n - Regex: '.*'\n Priority: 1\n SortPriority: 0\n CaseSensitive: false\n - Regex: '^(<|\"(gtest|gmock|isl|json)/)'\n Priority: 3\n SortPriority: 0\n CaseSensitive: false\n - Regex: '.*'\n Priority: 1\n SortPriority: 0\n CaseSensitive: false\nIncludeIsMainRegex: '(Test)?$'\nIncludeIsMainSourceRegex: ''\nIndentAccessModifiers: false\nIndentCaseBlocks: false\nIndentCaseLabels: false\nIndentExternBlock: AfterExternBlock\nIndentGotoLabels: true\nIndentPPDirectives: None\nIndentRequiresClause: false\nIndentWidth: 4\nIndentWrappedFunctionNames: true\nInsertBraces: false\nInsertNewlineAtEOF: true\nInsertTrailingCommas: None\nIntegerLiteralSeparator:\n Binary: 0\n BinaryMinDigits: 0\n Decimal: 0\n DecimalMinDigits: 0\n Hex: 0\n HexMinDigits: 0\nJavaScriptQuotes: Leave\nJavaScriptWrapImports: true\nKeepEmptyLinesAtTheStartOfBlocks: false\nKeepEmptyLinesAtEOF: false\nLambdaBodyIndentation: Signature\nLineEnding: DeriveLF\nMacroBlockBegin: ''\nMacroBlockEnd: ''\nMaxEmptyLinesToKeep: 1\nNamespaceIndentation: None\nObjCBinPackProtocolList: Auto\nObjCBlockIndentWidth: 4\nObjCBreakBeforeNestedBlockParam: true\nObjCSpaceAfterProperty: true\nObjCSpaceBeforeProtocolList: true\nPackConstructorInitializers: BinPack\nPenaltyBreakAssignment: 10\nPenaltyBreakBeforeFirstCallParameter: 30\nPenaltyBreakComment: 10\nPenaltyBreakFirstLessLess: 0\nPenaltyBreakOpenParenthesis: 0\nPenaltyBreakScopeResolution: 500\nPenaltyBreakString: 10\nPenaltyBreakTemplateDeclaration: 10\nPenaltyExcessCharacter: 100\nPenaltyIndentedWhitespace: 0\nPenaltyReturnTypeOnItsOwnLine: 60\nPointerAlignment: Left\nPPIndentWidth: -1\nQualifierAlignment: Leave\nReferenceAlignment: Pointer\nReflowComments: false\nRemoveBracesLLVM: false\nRemoveParentheses: Leave\nRemoveSemicolon: true\nRequiresClausePosition: OwnLine\nRequiresExpressionIndentation: OuterScope\nSeparateDefinitionBlocks: Leave\nShortNamespaceLines: 1\nSkipMacroDefinitionBody: false\nSortIncludes: Never\nSortJavaStaticImport: Before\nSortUsingDeclarations: Never\nSpaceAfterCStyleCast: false\nSpaceAfterLogicalNot: false\nSpaceAfterTemplateKeyword: true\nSpaceAroundPointerQualifiers: Default\nSpaceBeforeAssignmentOperators: true\nSpaceBeforeCaseColon: false\nSpaceBeforeCpp11BracedList: false\nSpaceBeforeCtorInitializerColon: true\nSpaceBeforeInheritanceColon: true\nSpaceBeforeJsonColon: false\nSpaceBeforeParens: Never\nSpaceBeforeParensOptions:\n AfterControlStatements: false\n AfterForeachMacros: false\n AfterFunctionDefinitionName: false\n AfterFunctionDeclarationName: false\n AfterIfMacros: false\n AfterOverloadedOperator: false\n AfterPlacementOperator: true\n AfterRequiresInClause: false\n AfterRequiresInExpression: false\n BeforeNonEmptyParentheses: false\nSpaceBeforeRangeBasedForLoopColon: true\nSpaceBeforeSquareBrackets: false\nSpaceInEmptyBlock: false\nSpacesBeforeTrailingComments: 1\nSpacesInAngles: Never\nSpacesInContainerLiterals: false\nSpacesInLineCommentPrefix:\n Minimum: 1\n Maximum: -1\nSpacesInParens: Never\nSpacesInParensOptions:\n InCStyleCasts: false\n InConditionalStatements: false\n InEmptyParentheses: false\n Other: false\nSpacesInSquareBrackets: false\nStandard: c++20\nStatementAttributeLikeMacros:\n - Q_EMIT\nStatementMacros:\n - Q_UNUSED\n - QT_REQUIRE_VERSION\nTabWidth: 4\nUseTab: Never\nVerilogBreakBetweenInstancePorts: true\nWhitespaceSensitiveMacros:\n - STRINGIZE\n - PP_STRINGIZE\n - BOOST_PP_STRINGIZE\n - NS_SWIFT_NAME\n - CF_SWIFT_NAME\n...\n\n"
},
{
"path": ".clangd",
"content": "CompileFlags:\n Add: \n - -Wno-unknown-warning-option\n - -Wno-format\n Remove: \n - -mword-relocations\n\nDiagnostics:\n ClangTidy:\n FastCheckFilter: None\n\n---\n\nIf:\n PathMatch: .*\\.h\nDiagnostics:\n UnusedIncludes: None\n"
},
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nend_of_line = lf\ninsert_final_newline = true\ncharset = utf-8\n\n[*.{cpp,h,c,py,sh}]\nindent_style = space\nindent_size = 4\n"
},
{
"path": ".gitattributes",
"content": "* text=auto eol=lf\n*.bat eol=crlf\n*.ps1 eol=crlf\n*.cmd eol=crlf\n"
},
{
"path": ".github/CODEOWNERS",
"content": "# Who owns all the fish by default\n* @DrZlo13 @hedger @gsurkov\n\n# Apps\n/applications/debug/bt_debug_app/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/debug/accessor/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/battery_test_app/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/debug/bt_debug_app/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/debug/file_browser_test/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/lfrfid_debug/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/text_box_test/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/uart_echo/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/usb_mouse/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/debug/usb_test/ @DrZlo13 @hedger @gsurkov @nminaylov\n\n/applications/main/archive/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/main/bad_usb/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/main/gpio/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/main/ibutton/ @DrZlo13 @hedger @gsurkov\n/applications/main/infrared/ @DrZlo13 @hedger @gsurkov\n/applications/main/nfc/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/main/subghz/ @DrZlo13 @hedger @gsurkov @Skorpionm\n/applications/main/u2f/ @DrZlo13 @hedger @gsurkov @nminaylov\n\n/applications/services/bt/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/services/cli/ @DrZlo13 @hedger @gsurkov @nminaylov @portasynthinca3\n/applications/services/crypto/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/services/desktop/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/services/dolphin/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/services/power/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/services/rpc/ @DrZlo13 @hedger @gsurkov @nminaylov\n\n/applications/services/bt_settings_app/ @DrZlo13 @hedger @gsurkov @gornekich\n/applications/services/desktop_settings/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/services/dolphin_passport/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/services/power_settings_app/ @DrZlo13 @hedger @gsurkov @gornekich\n\n/applications/system/storage_move_to_sd/ @DrZlo13 @hedger @gsurkov @nminaylov\n/applications/system/js_app/ @DrZlo13 @hedger @gsurkov @nminaylov @portasynthinca3\n\n/applications/debug/unit_tests/ @DrZlo13 @hedger @gsurkov @nminaylov @gornekich @Skorpionm\n\n/applications/examples/example_thermo/ @DrZlo13 @hedger @gsurkov\n\n# Firmware targets\n/targets/ @DrZlo13 @hedger @gsurkov @nminaylov\n\n# Assets\n/applications/main/infrared/resources/ @DrZlo13 @hedger @gsurkov\n\n# Documentation\n/documentation/ @DrZlo13 @hedger @gsurkov @portasynthinca3\n/scripts/toolchain/ @DrZlo13 @hedger @gsurkov\n\n# Lib\n/lib/stm32wb_copro/ @DrZlo13 @hedger @gsurkov @gornekich\n/lib/digital_signal/ @DrZlo13 @hedger @gsurkov @gornekich\n/lib/infrared/ @DrZlo13 @hedger @gsurkov\n/lib/lfrfid/ @DrZlo13 @hedger @gsurkov @nminaylov\n/lib/libusb_stm32/ @DrZlo13 @hedger @gsurkov @nminaylov\n/lib/mbedtls/ @DrZlo13 @hedger @gsurkov @nminaylov\n/lib/mjs/ @DrZlo13 @hedger @gsurkov @nminaylov @portasynthinca3\n/lib/nanopb/ @DrZlo13 @hedger @gsurkov @nminaylov\n/lib/nfc/ @DrZlo13 @hedger @gsurkov @gornekich\n/lib/one_wire/ @DrZlo13 @hedger @gsurkov\n/lib/subghz/ @DrZlo13 @hedger @gsurkov @Skorpionm\n/lib/toolbox/ @DrZlo13 @hedger @gsurkov\n/lib/toolbox/cli @DrZlo13 @hedger @gsurkov @portasynthinca3\n\n# CI/CD\n/.github/workflows/ @DrZlo13 @hedger @gsurkov\n"
},
{
"path": ".github/ISSUE_TEMPLATE/01_bug_report.yml",
"content": "name: Bug report\ndescription: File a bug reports regarding the firmware.\nlabels: ['bug']\nbody:\n- type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out an issue, this template is meant for any issues related to the Flipper Zero firmware.\n If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one)\n- type: textarea\n id: description\n attributes:\n label: Describe the bug.\n description: \"A clear and concise description of what the bug is.\"\n validations:\n required: true\n- type: textarea\n id: repro\n attributes: \n label: Reproduction\n description: \"How can this bug be reproduced?\"\n placeholder: |\n 1. Switch on...\n 2. Press button '....'\n 3. Wait for the moon phase\n 4. It burns\n validations:\n required: true\n- type: input\n id: target\n attributes:\n label: Target\n description: Specify the target\n # Target seems to be largely ignored by outside sources.\n- type: textarea\n id: logs\n attributes:\n label: Logs\n description: Attach your debug logs here\n render: Text\n # Avoid rendering as Markdown here.\n- type: textarea\n id: anything-else\n attributes:\n label: Anything else?\n description: Let us know if you have anything else to share.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/02_enhancements.yml",
"content": "name: Enhancements\ndescription: Suggest improvements for any existing functionality within the firmware.\nbody:\n- type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out an issue. This template is meant for feature requests and improvements to already existing functionality.\n If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one)\n- type: textarea\n id: proposal\n attributes:\n label: \"Describe the enhancement you're suggesting.\"\n description: |\n Feel free to describe in as much detail as you wish.\n validations:\n required: true\n- type: textarea\n id: anything-else\n attributes:\n label: Anything else?\n description: Let us know if you have anything else to share.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/03_feature_request.yml",
"content": "name: Feature Request\ndescription: For feature requests regarding the firmware.\nlabels: ['feature request']\nbody:\n- type: markdown\n attributes:\n value: |\n Thank you for taking the time to fill out an issue, this template is meant for any feature suggestions.\n If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one)\n- type: textarea\n id: proposal\n attributes:\n label: \"Description of the feature you're suggesting.\"\n description: |\n Please describe your feature request in as many details as possible.\n - Describe what it should do.\n - Note whether it is to extend existing functionality or introduce new functionality.\n validations:\n required: true\n- type: textarea\n id: anything-else\n attributes:\n label: Anything else?\n description: Let us know if you have anything else to share.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "blank_issues_enabled: true\ncontact_links:\n - name: Need help?\n url: https://forum.flipperzero.one\n about: For any question regarding on how to use the Flipper Zero and its firmware.\n"
},
{
"path": ".github/actions/submit_sdk/action.yml",
"content": "name: Submit SDK to Catalog\nauthor: hedger\ndescription: |\n This action checks if SDK exists in the catalog and if not, adds and/or publishes it.\n\ninputs:\n catalog-url:\n description: The URL of the Catalog API. Must not be empty or end with a /.\n required: true\n catalog-api-token:\n description: The token to use to authenticate with the Catalog API. Must not be empty.\n required: true\n firmware-api:\n description: Fimware's API version, major.minor\n required: true\n firmware-target:\n description: Firmware's target, e.g. f7/f18\n required: true\n firmware-version:\n description: Firmware's version, e.g. 0.13.37-rc3, or 0.13.37\n required: true\n\nruns:\n using: composite\n steps:\n - name: Check inputs\n shell: bash\n run: |\n if [ -z \"${{ inputs.catalog-url }}\" ] ; then\n echo \"Invalid catalog-url: ${{ inputs.catalog-url }}\"\n exit 1\n fi\n if [ -z \"${{ inputs.catalog-api-token }}\" ] ; then\n echo \"Invalid catalog-api-token: ${{ inputs.catalog-api-token }}\"\n exit 1\n fi\n if ! echo \"${{ inputs.firmware-api }}\" | grep -q \"^[0-9]\\+\\.[0-9]\\+$\" ; then\n echo \"Invalid firmware-api: ${{ inputs.firmware-api }}\"\n exit 1\n fi\n if ! echo \"${{ inputs.firmware-target }}\" | grep -q \"^f[0-9]\\+$\" ; then\n echo \"Invalid firmware-target: ${{ inputs.firmware-target }}\"\n exit 1\n fi\n if ! echo \"${{ inputs.firmware-version }}\" | grep -q \"^[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+\\(-rc\\)\\?\\([0-9]\\+\\)\\?$\" ; then\n echo \"Invalid firmware-version: ${{ inputs.firmware-version }}\"\n exit 1\n fi\n - name: Submit SDK\n shell: bash\n run: |\n curl --fail -sX 'GET' \\\n '${{ inputs.catalog-url }}/api/v0/0/sdk?length=500' \\\n -H 'Accept: application/json' > sdk_versions.json\n if jq -r -e \".[] | select((.api == \\\"${{ inputs.firmware-api }}\\\") and .target == \\\"${{ inputs.firmware-target }}\\\")\" sdk_versions.json > found_sdk.json ; then\n echo \"API version ${{ inputs.firmware-api }} already exists in catalog\"\n if [ $(jq -r -e \".released_at\" found_sdk.json) != \"null\" ] ; then\n echo \"API version is already released\"\n exit 0\n fi\n if ! echo \"${{ inputs.firmware-version }}\" | grep -q -- \"-rc\" ; then\n SDK_ID=$(jq -r ._id found_sdk.json)\n echo \"Marking SDK $SDK_ID as released\"\n curl --fail-with-body -X 'POST' \\\n \"${{ inputs.catalog-url }}/api/v0/0/sdk/${SDK_ID}/release\" \\\n -H 'Accept: application/json' \\\n -H 'Authorization: Bearer ${{ inputs.catalog-api-token }}' \\\n -d ''\n fi\n else\n echo \"API version ${{ inputs.firmware-api }} doesn't exist in catalog, adding\"\n curl --fail-with-body -X 'POST' \\\n '${{ inputs.catalog-url }}/api/v0/0/sdk' \\\n -H 'Accept: application/json' \\\n -H 'Authorization: Bearer ${{ inputs.catalog-api-token }}' \\\n -H 'Content-Type: application/json' \\\n -d \"{\\\"name\\\": \\\"${{ inputs.firmware-version }}\\\", \\\"target\\\": \\\"${{ inputs.firmware-target }}\\\", \\\"api\\\": \\\"${{ inputs.firmware-api }}\\\"}\"\n fi\n"
},
{
"path": ".github/pull_request_template.md",
"content": "# What's new\n\n- [ Describe changes here ]\n\n# Verification \n\n- [ Describe how to verify changes ]\n\n# Checklist (For Reviewer)\n\n- [ ] PR has description of feature/bug or link to Confluence/Jira task\n- [ ] Description contains actions to verify feature/bugfix\n- [ ] I've built this code, uploaded it to the device and verified feature/bugfix\n"
},
{
"path": ".github/workflows/build.yml",
"content": "name: 'Build'\n\non:\n push:\n branches:\n - dev\n tags:\n - '*'\n pull_request:\n\nenv:\n DEFAULT_TARGET: f7\n FBT_TOOLCHAIN_PATH: /runner/_work\n FBT_GIT_SUBMODULE_SHALLOW: 1\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n main:\n runs-on: [self-hosted, FlipperZeroShell]\n strategy:\n fail-fast: false\n matrix:\n target: [f7, f18]\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Get commit details'\n id: names\n run: |\n BUILD_TYPE='DEBUG=1 COMPACT=0'\n if [[ ${{ github.event_name }} == 'pull_request' ]]; then\n TYPE=\"pull\"\n elif [[ \"${{ github.ref }}\" == \"refs/tags/\"* ]]; then\n TYPE=\"tag\"\n BUILD_TYPE='DEBUG=0 COMPACT=1'\n else\n TYPE=\"other\"\n fi\n python3 scripts/get_env.py \"--event_file=${{ github.event_path }}\" \"--type=$TYPE\" || cat \"${{ github.event_path }}\"\n echo \"event_type=$TYPE\" >> $GITHUB_OUTPUT\n echo \"FBT_BUILD_TYPE=$BUILD_TYPE\" >> $GITHUB_ENV\n echo \"TARGET=${{ matrix.target }}\" >> $GITHUB_ENV\n echo \"TARGET_HW=$(echo \"${{ matrix.target }}\" | sed 's/f//')\" >> $GITHUB_ENV\n\n - name: 'Check API versions for consistency between targets'\n run: |\n set -e\n N_API_HEADER_SIGNATURES=`ls -1 targets/f*/api_symbols.csv | xargs -I {} sh -c \"head -n2 {} | md5sum\" | sort -u | wc -l`\n if [ $N_API_HEADER_SIGNATURES != 1 ] ; then\n echo API versions aren\\'t matching for available targets. Please update!\n echo API versions are:\n head -n2 targets/f*/api_symbols.csv\n exit 1\n fi\n\n - name: 'Build the firmware and apps'\n id: build-fw\n run: |\n ./fbt TARGET_HW=$TARGET_HW $FBT_BUILD_TYPE copro_dist updater_package fap_dist\n echo \"firmware_api=$(./fbt TARGET_HW=$TARGET_HW get_apiversion)\" >> $GITHUB_OUTPUT\n\n - name: 'Check for uncommitted changes'\n run: |\n git diff --exit-code\n\n - name: 'Copy build output'\n run: |\n set -e\n rm -rf artifacts map_analyser_files || true\n mkdir artifacts map_analyser_files\n cp dist/${TARGET}-*/* artifacts/ || true\n tar czpf \"artifacts/flipper-z-${TARGET}-resources-${SUFFIX}.tgz\" \\\n -C build/latest resources\n tar czpf \"artifacts/flipper-z-${TARGET}-debugapps-${SUFFIX}.tgz\" \\\n -C dist/${TARGET}-*/apps/Debug .\n tar czpf \"artifacts/flipper-z-${TARGET}-appsymbols-${SUFFIX}.tgz\" \\\n -C dist/${TARGET}-*/debug_elf .\n\n - name: 'Copy universal artifacts'\n if: ${{ !github.event.pull_request.head.repo.fork && matrix.target == env.DEFAULT_TARGET }}\n run: |\n tar czpf \"artifacts/flipper-z-any-scripts-${SUFFIX}.tgz\" scripts\n cp build/core2_firmware.tgz \"artifacts/flipper-z-any-core2_firmware-${SUFFIX}.tgz\"\n\n - name: 'Upload artifacts to update server'\n if: ${{ !github.event.pull_request.head.repo.fork }}\n run: |\n FILES=$(for ARTIFACT in $(find artifacts -maxdepth 1 -not -type d); do echo \"-F files=@${ARTIFACT}\"; done)\n curl --fail -L -H \"Token: ${{ secrets.INDEXER_TOKEN }}\" \\\n -F \"branch=${BRANCH_NAME}\" \\\n -F \"version_token=${COMMIT_SHA}\" \\\n ${FILES[@]} \\\n \"${{ secrets.INDEXER_URL }}\"/firmware/uploadfiles\n\n - name: 'Copy & analyse map analyser files'\n if: ${{ !github.event.pull_request.head.repo.fork && matrix.target == env.DEFAULT_TARGET }}\n run: |\n cp build/${DEFAULT_TARGET}-firmware-*/firmware.elf.map map_analyser_files/firmware.elf.map\n cp build/${DEFAULT_TARGET}-firmware-*/firmware.elf map_analyser_files/firmware.elf\n source scripts/toolchain/fbtenv.sh\n python3 scripts/map_analyse_upload.py \\\n \"--elf_file=map_analyser_files/firmware.elf\" \\\n \"--map_file=map_analyser_files/firmware.elf.map\" \\\n \"--analyser_url=${{ secrets.ANALYSER_URL }}\" \\\n \"--analyser_token=${{ secrets.ANALYSER_TOKEN }}\";\n\n - name: 'Find previous comment'\n if: ${{ !github.event.pull_request.head.repo.fork && matrix.target == env.DEFAULT_TARGET && github.event.pull_request }}\n uses: peter-evans/find-comment@v3\n id: find-comment\n with:\n issue-number: ${{ github.event.pull_request.number }}\n comment-author: 'github-actions[bot]'\n body-includes: 'Compiled ${{ matrix.target }} firmware for commit'\n\n - name: 'Create or update comment'\n if: ${{ !github.event.pull_request.head.repo.fork && matrix.target == env.DEFAULT_TARGET && github.event.pull_request }}\n uses: peter-evans/create-or-update-comment@v4\n with:\n comment-id: ${{ steps.find-comment.outputs.comment-id }}\n issue-number: ${{ github.event.pull_request.number }}\n body: |\n **Compiled ${{ matrix.target }} firmware for commit `${{steps.names.outputs.commit_sha}}`:**\n - [📦 Update package](https://update.flipperzero.one/builds/firmware/${{steps.names.outputs.branch_name}}/flipper-z-${{steps.names.outputs.default_target}}-update-${{steps.names.outputs.suffix}}.tgz)\n - [📥 DFU file](https://update.flipperzero.one/builds/firmware/${{steps.names.outputs.branch_name}}/flipper-z-${{steps.names.outputs.default_target}}-full-${{steps.names.outputs.suffix}}.dfu)\n - [☁️ Web/App updater](https://lab.flipper.net/?url=https://update.flipperzero.one/builds/firmware/${{steps.names.outputs.branch_name}}/flipper-z-${{steps.names.outputs.default_target}}-update-${{steps.names.outputs.suffix}}.tgz&channel=${{steps.names.outputs.branch_name}}&version=${{steps.names.outputs.commit_sha}})\n - [📊 Size report](https://fw-reports.flipp.dev/?branch=${{steps.names.outputs.branch_name}})\n edit-mode: replace\n\n - name: 'SDK submission to staging catalog'\n if: ${{ steps.names.outputs.event_type == 'tag' && matrix.target == env.DEFAULT_TARGET }}\n uses: ./.github/actions/submit_sdk\n with:\n catalog-url: ${{ secrets.CATALOG_STAGING_URL }}\n catalog-api-token: ${{ secrets.CATALOG_STAGING_API_TOKEN }}\n firmware-api: ${{ steps.build-fw.outputs.firmware_api }}\n firmware-target: ${{ matrix.target }}\n firmware-version: ${{ steps.names.outputs.suffix }}\n\n - name: 'SDK submission to prod catalog'\n if: ${{ steps.names.outputs.event_type == 'tag' && matrix.target == env.DEFAULT_TARGET }}\n uses: ./.github/actions/submit_sdk\n with:\n catalog-url: ${{ secrets.CATALOG_URL }}\n catalog-api-token: ${{ secrets.CATALOG_API_TOKEN }}\n firmware-api: ${{ steps.build-fw.outputs.firmware_api }}\n firmware-target: ${{ matrix.target }}\n firmware-version: ${{ steps.names.outputs.suffix }}\n"
},
{
"path": ".github/workflows/build_compact.yml",
"content": "name: 'Compact build'\n\non:\n pull_request:\n\nenv:\n FBT_TOOLCHAIN_PATH: /runner/_work\n FBT_GIT_SUBMODULE_SHALLOW: 1\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n compact:\n runs-on: [self-hosted, FlipperZeroShell]\n strategy:\n fail-fast: false\n matrix:\n target: [f7, f18]\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n submodules: false\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Get commit details'\n run: |\n if [[ ${{ github.event_name }} == 'pull_request' ]]; then\n TYPE=\"pull\"\n elif [[ \"${{ github.ref }}\" == \"refs/tags/\"* ]]; then\n TYPE=\"tag\"\n else\n TYPE=\"other\"\n fi\n python3 scripts/get_env.py \"--event_file=${{ github.event_path }}\" \"--type=$TYPE\" || cat \"${{ github.event_path }}\"\n\n - name: 'Build the firmware'\n id: build-fw\n run: |\n set -e\n TARGET=\"$(echo '${{ matrix.target }}' | sed 's/f//')\"; \\\n ./fbt TARGET_HW=$TARGET DEBUG=0 COMPACT=1 fap_dist updater_package\n echo \"sdk-file=$(ls dist/${{ matrix.target }}-*/flipper-z-${{ matrix.target }}-sdk-*.zip)\" >> $GITHUB_OUTPUT\n echo \"hw-target-code=$TARGET\" >> $GITHUB_OUTPUT\n\n - name: Deploy uFBT with SDK\n uses: flipperdevices/flipperzero-ufbt-action@v0.1\n with:\n task: setup\n sdk-file: ${{ steps.build-fw.outputs.sdk-file }}\n sdk-hw-target: ${{ steps.build-fw.outputs.hw-target-code }}\n\n - name: Build test app with SDK\n run: |\n mkdir testapp\n cd testapp\n ufbt create APPID=testapp\n ufbt\n\n - name: Build example & external apps with uFBT\n run: |\n for appdir in 'applications/examples'; do\n for app in $(find \"$appdir\" -maxdepth 1 -mindepth 1 -type d); do\n pushd $app\n TARGETS_FAM=$(grep \"targets\" application.fam || echo \"${{ matrix.target }}\")\n if ! grep -q \"${{ matrix.target }}\" <<< $TARGETS_FAM ; then\n echo Skipping unsupported app: $app\n popd\n continue\n fi\n echo Building $app\n ufbt\n popd\n done\n done\n\n## Uncomment this for a single job that will run only if all targets are built successfully \n# report-status:\n# name: Report status\n# needs: [compact]\n# if: always() && !contains(needs.*.result, 'failure')\n# runs-on: [self-hosted, FlipperZeroShell]\n# steps:\n# - run: echo \"All good ✨\" ;\n"
},
{
"path": ".github/workflows/docs.yml",
"content": "name: 'Generate documentation with Doxygen'\n\non:\n push:\n branches:\n - dev\n pull_request:\n\nenv:\n TARGETS: f7\n DEFAULT_TARGET: f7\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n check-secret:\n if: ${{ github.event.pull_request.head.repo.fork == false }}\n runs-on: ubuntu-latest\n outputs:\n s3-valid-config: ${{ steps.check.outputs.s3-valid-config }}\n\n steps:\n - name: 'Check if S3 key exists'\n id: check\n run: |\n if [[ -z \"${{ secrets.FW_DOCS_AWS_ACCESS_KEY }}\" || -z \"${{ secrets.FW_DOCS_AWS_SECRET_KEY }}\" || -z \"${{ secrets.FW_DOCS_AWS_BUCKET }}\" ]]; then\n echo \"s3-valid-config=false\" >> $GITHUB_OUTPUT;\n else\n echo \"s3-valid-config=true\" >> $GITHUB_OUTPUT;\n fi\n\n doxygen:\n if: ${{ github.event.pull_request.head.repo.fork == false }}\n runs-on: ubuntu-latest\n needs: check-secret\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n submodules: true\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Get commit details'\n id: names\n run: |\n if [[ ${{ github.event_name }} == 'pull_request' ]]; then\n TYPE=\"pull\"\n elif [[ \"${{ github.ref }}\" == \"refs/tags/\"* ]]; then\n TYPE=\"tag\"\n else\n TYPE=\"other\"\n fi\n python3 scripts/get_env.py \"--event_file=${{ github.event_path }}\" \"--type=$TYPE\"\n\n - name: install-doxygen\n uses: AdarshRawat1/Install-Doxygen@v1.0\n with:\n version: \"1.12.0\"\n\n - name: 'Generate documentation'\n run: ./fbt doxygen\n\n - name: 'Upload documentation'\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/dev' && needs.check-secret.outputs.s3-valid-config == 'true' }}\n uses: jakejarvis/s3-sync-action@v0.5.1\n env:\n AWS_S3_BUCKET: \"${{ secrets.FW_DOCS_AWS_BUCKET }}\"\n AWS_ACCESS_KEY_ID: \"${{ secrets.FW_DOCS_AWS_ACCESS_KEY }}\"\n AWS_SECRET_ACCESS_KEY: \"${{ secrets.FW_DOCS_AWS_SECRET_KEY }}\"\n AWS_REGION: \"${{ secrets.FW_DOCS_AWS_REGION }}\"\n SOURCE_DIR: \"./documentation/doxygen/build/html\"\n DEST_DIR: \"${{steps.names.outputs.branch_name}}\"\n with:\n args: \"--delete\"\n"
},
{
"path": ".github/workflows/lint_and_submodule_check.yml",
"content": "name: 'Lint sources & check submodule integrity'\n\non:\n pull_request:\n\nenv:\n TARGETS: f7\n FBT_TOOLCHAIN_PATH: /runner/_work\n SET_GH_OUTPUT: 1\n\njobs:\n lint_sources_check_submodules:\n runs-on: [self-hosted, FlipperZeroShell]\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n fetch-depth: 2\n ref: ${{ github.sha }}\n\n - name: 'Check protobuf branch'\n run: |\n git submodule update --init;\n SUB_PATH=\"assets/protobuf\";\n SUB_BRANCH=\"dev\";\n SUB_COMMITS_MIN=40;\n cd \"$SUB_PATH\";\n SUBMODULE_HASH=\"$(git rev-parse HEAD)\";\n BRANCHES=$(git branch -r --contains \"$SUBMODULE_HASH\");\n COMMITS_IN_BRANCH=\"$(git rev-list --count dev)\";\n if [ $COMMITS_IN_BRANCH -lt $SUB_COMMITS_MIN ]; then\n echo \"name=fails::error\" >> $GITHUB_OUTPUT;\n echo \"::error::Error: Too few commits in $SUB_BRANCH of submodule $SUB_PATH: $COMMITS_IN_BRANCH(expected $SUB_COMMITS_MIN+)\";\n exit 1;\n fi\n if ! grep -q \"/$SUB_BRANCH\" <<< \"$BRANCHES\"; then\n echo \"name=fails::error\" >> $GITHUB_OUTPUT;\n echo \"::error::Error: Submodule $SUB_PATH is not on branch $SUB_BRANCH\";\n exit 1;\n fi\n\n - name: 'Check for new TODOs'\n id: check_todos\n if: github.event_name == 'pull_request'\n run: |\n set +e;\n git diff --unified=0 --no-color ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep -E '^\\+' | grep -i -E '(TODO|HACK|FIXME|XXX)[ :]' | grep -v -- '-nofl' > lines.log;\n MISSING_TICKETS=$( grep -v -E 'FL-[0-9]+' lines.log );\n if [ -n \"$MISSING_TICKETS\" ]; then\n echo \"Error: Missing ticket number in \\`TODO\\` comment(s)\" >> $GITHUB_STEP_SUMMARY;\n echo \"\\`\\`\\`\" >> $GITHUB_STEP_SUMMARY;\n echo \"$MISSING_TICKETS\" >> $GITHUB_STEP_SUMMARY;\n echo \"\\`\\`\\`\" >> $GITHUB_STEP_SUMMARY;\n echo \"Error: Missing issue number in comment(s):\";\n echo \"$MISSING_TICKETS\";\n exit 1;\n else\n echo \"No new TODOs without tickets found\" >> $GITHUB_STEP_SUMMARY;\n fi\n\n - name: 'Check Python code formatting'\n id: syntax_check_py\n if: always()\n run: |\n set +e;\n ./fbt -s lint_py 2>&1 | tee lint-py.log;\n if [ \"${PIPESTATUS[0]}\" -ne 0 ]; then\n # Save multiline output\n echo \"errors=1\" >> $GITHUB_OUTPUT;\n printf \"Python Lint errors:\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n echo \"$(cat lint-py.log)\" >> $GITHUB_STEP_SUMMARY;\n printf \"\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n exit 1;\n else\n echo \"Python Lint: all good ✨\" >> $GITHUB_STEP_SUMMARY;\n fi\n\n - name: 'Check C++ code formatting'\n id: syntax_check_cpp\n if: always()\n run: |\n set +e;\n ./fbt -s lint 2>&1 | tee lint-cpp.log;\n if [ \"${PIPESTATUS[0]}\" -ne 0 ]; then\n # Save multiline output\n echo \"errors=1\" >> $GITHUB_OUTPUT;\n printf \"C Lint errors:\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n echo \"$(cat lint-cpp.log)\" >> $GITHUB_STEP_SUMMARY;\n printf \"\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n exit 1;\n else\n echo \"C Lint: all good ✨\" >> $GITHUB_STEP_SUMMARY;\n fi\n\n - name: 'Check image assets'\n if: always()\n run: |\n set +e;\n ./fbt -s lint_img 2>&1 | tee lint-assets.log;\n if [ \"${PIPESTATUS[0]}\" -ne 0 ]; then\n # Save multiline output\n echo \"errors=1\" >> $GITHUB_OUTPUT;\n printf \"Image Lint errors:\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n echo \"$(cat lint-assets.log)\" >> $GITHUB_STEP_SUMMARY;\n printf \"\\n\\`\\`\\`\\n\" >> $GITHUB_STEP_SUMMARY;\n exit 1;\n else\n echo \"Image Lint: all good ✨\" >> $GITHUB_STEP_SUMMARY;\n fi\n\n - name: Report code formatting errors\n if: ( steps.syntax_check_py.outputs.errors || steps.syntax_check_cpp.outputs.errors ) && github.event.pull_request\n run: |\n echo \"Code formatting errors found\";\n echo \"Please run './fbt format' or './fbt format_py' to fix them\";\n exit 1;\n"
},
{
"path": ".github/workflows/merge_report.yml",
"content": "name: 'Check FL ticket in PR name'\n\non:\n push:\n branches:\n - dev\n\nenv:\n FBT_TOOLCHAIN_PATH: /runner/_work\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n merge_report:\n runs-on: [self-hosted, FlipperZeroShell]\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Get commit details'\n run: |\n if [[ ${{ github.event_name }} == 'pull_request' ]]; then\n TYPE=\"pull\"\n elif [[ \"${{ github.ref }}\" == \"refs/tags/\"* ]]; then\n TYPE=\"tag\"\n else\n TYPE=\"other\"\n fi\n python3 scripts/get_env.py \"--event_file=${{ github.event_path }}\" \"--type=$TYPE\" || cat \"${{ github.event_path }}\"\n\n - name: 'Check ticket and report'\n run: |\n source scripts/toolchain/fbtenv.sh\n python3 -m pip install slack_sdk\n python3 scripts/merge_report_qa.py \\\n ${{ secrets.QA_REPORT_SLACK_TOKEN }} \\\n ${{ secrets.QA_REPORT_SLACK_CHANNEL }}\n\n"
},
{
"path": ".github/workflows/pvs_studio.yml",
"content": "name: 'Static C/C++ analysis with PVS-Studio'\n\non:\n push:\n branches:\n - dev\n pull_request:\n\nenv:\n TARGETS: f7\n DEFAULT_TARGET: f7\n FBT_TOOLCHAIN_PATH: /runner/_work\n FBT_GIT_SUBMODULE_SHALLOW: 1\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n analyse_c_cpp:\n if: ${{ !github.event.pull_request.head.repo.fork }}\n runs-on: [self-hosted, FlipperZeroShell]\n steps:\n - name: 'Wipe workspace'\n run: find ./ -mount -maxdepth 1 -exec rm -rf {} \\;\n\n - name: 'Checkout code'\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Get commit details'\n id: names\n run: |\n if [[ ${{ github.event_name }} == 'pull_request' ]]; then\n TYPE=\"pull\"\n elif [[ \"${{ github.ref }}\" == \"refs/tags/\"* ]]; then\n TYPE=\"tag\"\n else\n TYPE=\"other\"\n fi\n python3 scripts/get_env.py \"--event_file=${{ github.event_path }}\" \"--type=$TYPE\" || cat \"${{ github.event_path }}\"\n\n - name: 'Supply PVS credentials'\n run: |\n pvs-studio-analyzer credentials ${{ secrets.PVS_STUDIO_CREDENTIALS }}\n\n - name: 'Convert PVS-Studio output to html and detect warnings'\n id: pvs-warn\n run: |\n WARNINGS=0\n ./fbt COMPACT=1 PVSNOBROWSER=1 firmware_pvs || WARNINGS=1\n echo \"warnings=${WARNINGS}\" >> $GITHUB_OUTPUT\n if [[ $WARNINGS -ne 0 ]]; then\n echo \"report-url=https://pvs.flipp.dev/${{steps.names.outputs.branch_name}}/${{steps.names.outputs.default_target}}-${{steps.names.outputs.suffix}}/index.html\" >> $GITHUB_OUTPUT\n fi\n\n - name: 'Upload report'\n if: ${{ !github.event.pull_request.head.repo.fork && (steps.pvs-warn.outputs.warnings != 0) }}\n uses: prewk/s3-cp-action@v2\n with:\n aws_s3_endpoint: \"${{ secrets.PVS_AWS_ENDPOINT }}\"\n aws_access_key_id: \"${{ secrets.PVS_AWS_ACCESS_KEY }}\"\n aws_secret_access_key: \"${{ secrets.PVS_AWS_SECRET_KEY }}\"\n source: \"./build/f7-firmware-DC/pvsreport\"\n dest: \"s3://${{ secrets.PVS_AWS_BUCKET }}/${{steps.names.outputs.branch_name}}/${{steps.names.outputs.default_target}}-${{steps.names.outputs.suffix}}/\"\n flags: \"--recursive --acl public-read\"\n\n - name: 'Find Previous Comment'\n if: ${{ !github.event.pull_request.head.repo.fork && github.event.pull_request && (steps.pvs-warn.outputs.warnings != 0) }}\n uses: peter-evans/find-comment@v3\n id: fc\n with:\n issue-number: ${{ github.event.pull_request.number }}\n comment-author: 'github-actions[bot]'\n body-includes: 'PVS-Studio report for commit'\n\n - name: 'Create or update comment'\n if: ${{ !github.event.pull_request.head.repo.fork && github.event.pull_request && (steps.pvs-warn.outputs.warnings != 0) }}\n uses: peter-evans/create-or-update-comment@v4\n with:\n comment-id: ${{ steps.fc.outputs.comment-id }}\n issue-number: ${{ github.event.pull_request.number }}\n body: |\n **PVS-Studio report for commit `${{steps.names.outputs.commit_sha}}`:**\n - [Report](${{ steps.pvs-warn.outputs.report-url }})\n edit-mode: replace\n\n - name: 'Raise exception'\n if: ${{ steps.pvs-warn.outputs.warnings != 0 }}\n run: |\n echo \"Please fix all PVS warnings before merge\"\n echo \"Report: ${{ steps.pvs-warn.outputs.report-url }}\"\n echo \"[PVS report](${{ steps.pvs-warn.outputs.report-url }})\" >> $GITHUB_STEP_SUMMARY\n exit 1\n"
},
{
"path": ".github/workflows/reindex.yml",
"content": "name: 'Post-release hooks'\n\non:\n release:\n types: [prereleased, released]\n\njobs:\n reindex:\n name: 'Post-release hooks'\n runs-on: [self-hosted, FlipperZeroShell]\n steps:\n - name: 'Checkout code'\n uses: actions/checkout@v4\n\n - name: 'Trigger reindex'\n run: |\n curl --fail -L -H \"Token: ${{ secrets.INDEXER_TOKEN }}\" \\\n \"${{ secrets.INDEXER_URL }}\"/firmware/reindex;\n\n - name: 'Send release notification'\n if: ${{ github.event.action == 'released' }}\n run: |\n echo '${{ secrets.FIREBASE_TOKEN }}' > firebase-token.json;\n python3 -m pip install firebase-admin==6.4.0;\n python3 scripts/send_firebase_notification.py \\\n \"--version=${{ github.event.release.name }}\" \\\n \"--token=firebase-token.json\";\n\n - name: 'Remove firebase token'\n if: always()\n run: |\n rm -rf firebase-token.json;\n"
},
{
"path": ".github/workflows/unit_tests.yml",
"content": "name: 'Unit tests'\non:\n pull_request:\n\nenv:\n TARGETS: f7\n DEFAULT_TARGET: f7\n FBT_TOOLCHAIN_PATH: /opt/\n FBT_GIT_SUBMODULE_SHALLOW: 1\n\njobs:\n run_units_on_bench:\n runs-on: [ self-hosted, FlipperZeroTest ]\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Flash unit tests firmware'\n id: flashing\n if: success()\n timeout-minutes: 5\n run: |\n source scripts/toolchain/fbtenv.sh\n ./fbt resources firmware_latest flash LIB_DEBUG=1 FIRMWARE_APP_SET=unit_tests FORCE=1\n\n\n - name: 'Copy assets and unit data, reboot and wait for flipper'\n id: copy\n if: steps.flashing.outcome == 'success'\n timeout-minutes: 5\n run: |\n source scripts/toolchain/fbtenv.sh\n python3 scripts/testops.py -t=15 await_flipper\n python3 scripts/storage.py -f send build/latest/resources /ext\n python3 scripts/storage.py -f send /region_data /ext/.int/.region_data\n python3 scripts/power.py reboot\n python3 scripts/testops.py -t=30 await_flipper\n\n - name: 'Run units and validate results'\n id: run_units\n if: steps.copy.outcome == 'success'\n timeout-minutes: 5\n run: |\n source scripts/toolchain/fbtenv.sh\n python3 scripts/testops.py run_units\n\n - name: 'Upload test results'\n if: failure() && steps.flashing.outcome == 'success' && steps.run_units.outcome != 'skipped'\n uses: actions/upload-artifact@v4\n with:\n name: unit-tests_output\n path: unit_tests*.txt\n\n - name: 'Check GDB output'\n if: failure() && steps.flashing.outcome == 'success'\n run: |\n ./fbt gdb_trace_all LIB_DEBUG=1 FIRMWARE_APP_SET=unit_tests FORCE=1\n"
},
{
"path": ".github/workflows/updater_test.yml",
"content": "name: 'Updater test'\non:\n pull_request:\n\nenv:\n TARGETS: f7\n DEFAULT_TARGET: f7\n FBT_TOOLCHAIN_PATH: /opt/\n FBT_GIT_SUBMODULE_SHALLOW: 1\n\njobs:\n test_updater_on_bench:\n runs-on: [self-hosted, FlipperZeroTest ]\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 1\n ref: ${{ github.event.pull_request.head.sha }}\n\n - name: 'Flashing target firmware'\n id: first_full_flash\n timeout-minutes: 5\n run: |\n source scripts/toolchain/fbtenv.sh\n python3 scripts/testops.py -t=180 await_flipper\n ./fbt flash_usb_full FORCE=1\n \n\n - name: 'Validating updater'\n id: second_full_flash\n timeout-minutes: 5\n if: success()\n run: |\n source scripts/toolchain/fbtenv.sh\n python3 scripts/testops.py -t=180 await_flipper\n ./fbt flash_usb FORCE=1\n python3 scripts/testops.py -t=180 await_flipper\n\n"
},
{
"path": ".gitignore",
"content": "*~\n*.swp\n*.swo\n*.gdb_history\n*.old\n\n\n# LSP\n.cache\ncompile_commands.json\n\n# JetBrains IDEs\n.idea/\n\n# Sublime Text\n.sublime-project.sublime-workspace\n\n# Python VirtEnvironments\n.env\n.venv\nenv/\nvenv/\n\n# Python Byte-compiled / optimized files\n__pycache__/\n*.py[cod]\n*$py.class\n*.pickle\n\n.obj/\nbindings/\n.DS_Store\n.mxproject\nBrewfile.lock.json\n\n# Kate\n.kateproject\n.kateconfig\n\n# kde\n.directory\n\n# SCons\n.sconsign.dblite\n\n\n# bundle output\n/dist\n\n# SCons build dir\n/build\n\n# Toolchain\n/toolchain\n\n# openocd output file\nopenocd.log\n\n# PVS Studio temporary files\n.PVS-Studio/\nPVS-Studio.log\n*.PVS-Studio.*\n\n.gdbinit\n\n/fbt_options_local.py\n\n# JS packages\nnode_modules/\n\n# cli_perf script output in case of errors\n/block.bin\n/return_block.bin\n"
},
{
"path": ".gitmodules",
"content": "[submodule \"lib/mlib\"]\n\tpath = lib/mlib\n\turl = https://github.com/P-p-H-d/mlib.git\n[submodule \"lib/nanopb\"]\n\tpath = lib/nanopb\n\turl = https://github.com/nanopb/nanopb.git\n[submodule \"assets/protobuf\"]\n\tpath = assets/protobuf\n\turl = https://github.com/flipperdevices/flipperzero-protobuf.git\n\tshallow = false\n[submodule \"lib/libusb_stm32\"]\n\tpath = lib/libusb_stm32\n\turl = https://github.com/flipperdevices/libusb_stm32.git\n[submodule \"lib/FreeRTOS-Kernel\"]\n\tpath = lib/FreeRTOS-Kernel\n\turl = https://github.com/FreeRTOS/FreeRTOS-Kernel.git\n[submodule \"lib/microtar\"]\n\tpath = lib/microtar\n\turl = https://github.com/amachronic/microtar.git\n[submodule \"lib/mbedtls\"]\n\tpath = lib/mbedtls\n\turl = https://github.com/Mbed-TLS/mbedtls.git\n[submodule \"lib/heatshrink\"]\n\tpath = lib/heatshrink\n\turl = https://github.com/flipperdevices/heatshrink.git\n[submodule \"lib/st_cmsis_device_wb\"]\n\tpath = lib/stm32wb_cmsis\n\turl = https://github.com/STMicroelectronics/cmsis_device_wb\n[submodule \"lib/stm32wbxx_hal_driver\"]\n\tpath = lib/stm32wb_hal\n\turl = https://github.com/STMicroelectronics/stm32wbxx_hal_driver\n[submodule \"lib/stm32wb_copro\"]\n\tpath = lib/stm32wb_copro\n url = https://github.com/flipperdevices/stm32wb_copro.git\n[submodule \"documentation/doxygen/doxygen-awesome-css\"]\n\tpath = documentation/doxygen/doxygen-awesome-css\n\turl = https://github.com/jothepro/doxygen-awesome-css.git\n"
},
{
"path": ".pvsconfig",
"content": "# MLib macros we can't do much about.\n//-V:M_LET:1048,1044\n//-V:M_EACH:1048,1044\n//-V:ARRAY_DEF:760,747,568,776,729,712,654,1103\n//-V:LIST_DEF:760,747,568,712,729,654,776,1103\n//-V:LIST_DUAL_PUSH_DEF:524,760,774\n//-V:BPTREE_DEF2:779,1086,557,773,512\n//-V:DICT_DEF2:779,524,776,760,1044,1001,729,590,568,747,685,1103\n//-V:ALGO_DEF:1048,747,1044\n//-V:TUPLE_DEF2:524,590,1001,760\n//-V:DEQUE_DEF:658,747,760\n\n# Non-severe malloc/null pointer deref warnings\n//-V::522:2,3\n\n# Warning about headers with copyleft license\n//-V::1042\n\n# Potentially null argument warnings\n//-V:memset:575\n//-V:memcpy:575\n//-V:memcmp:575\n//-V:strlen:575\n//-V:strcpy:575\n//-V:strncpy:575\n//-V:strchr:575\n\n# For loop warning on M_FOREACH\n//-V:for:1044\n\n# Bitwise OR\n//-V:bit:792\n\n# Do not complain about similar code\n//-V::525\n\n# Common embedded development pointer operations\n//-V::566\n//-V::1032\n\n# Warnings about length mismatch\n//-V:property_value_out:666\n\n# Model-related warnings\n//-V:with_view_model:1044,1048\n\n# Examples\n//V_EXCLUDE_PATH applications/examples/\n"
},
{
"path": ".pvsoptions",
"content": "--ignore-ccache -C gccarm --rules-config .pvsconfig -e lib/cmsis_core -e lib/fatfs -e lib/fnv1a-hash -e lib/FreeRTOS-Kernel -e lib/heatshrink -e lib/libusb_stm32 -e lib/mbedtls -e lib/microtar -e lib/mlib -e lib/stm32wb_cmsis -e lib/stm32wb_copro -e lib/stm32wb_hal -e lib/u8g2 -e lib/nanopb -e lib/mjs -e */arm-none-eabi/*\n"
},
{
"path": ".sublime-project",
"content": "{\n \"folders\":\n [\n {\n \"path\": \".\",\n }\n ],\n \"settings\": {\n \"LSP\": {\n \"clangd\": {\n \"enabled\": true,\n \"initializationOptions\": {\n // Set `\"binary\": \"custom\",` option in LSP-clangd config to use toolchain clangd\n \"custom_command\": [\"toolchain/current/bin/clangd\"],\n \"clangd.compile-commands-dir\": \"build/latest\",\n \"clangd.header-insertion\": \"never\",\n \"clangd.query-driver\": \"**/arm-none-eabi-*\",\n \"clangd.clang-tidy\": true,\n },\n },\n },\n },\n}\n"
},
{
"path": ".vscode/ReadMe.md",
"content": "# Visual Studio Code workspace for Flipper Zero {#vscode}\n\n## Setup\n\n * To start developing with VSCode, run `./fbt vscode_dist` in project root. _That should only be done once_\n * After that, open firmware folder in VSCode: \"File\" > \"Open folder\"\n\n For more details on fbt, see [fbt docs](../documentation/fbt.md).\n\n\n## Workflow\n\nCommands for building firmware are invoked through Build menu: Ctrl+Shift+B.\n\nTo attach a debugging session, first build and flash firmware, then choose your debug probe in Debug menu (Ctrl+Shift+D).\n\nNote that you have to detach debugging session before rebuilding and re-flashing firmware.\n"
},
{
"path": "CODE_OF_CONDUCT.md",
"content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nhello@flipperdevices.com.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n"
},
{
"path": "CODING_STYLE.md",
"content": "# Intro\n\nNice to see you reading this document, we really appreciate it.\n\nAs all documents of this kind it's unable to cover everything.\nBut it will cover general rules that we are enforcing on PR review.\n\nAlso, we already have automatic rules checking and formatting,\nbut it got its limitations and this guide is still mandatory.\n\nSome part of this project do have its own naming and coding guides.\nFor example: assets. Take a look into `ReadMe.md` in assets folder for more details.\n\nAlso, 3rd party libraries are none of our concern.\n\nAnd yes, this set is not final and we are open to discussion.\nIf you want to add/remove/change something here please feel free to open new ticket.\n\n# Inspiration\n\nOur guide is inspired by, but not claiming to be compatible with:\n\n- https://www.kernel.org/doc/html/v4.10/process/coding-style.html\n- https://docs.unrealengine.com/en-US/Programming/Development/CodingStandard\n- https://webkit.org/code-style-guidelines/\n\n# General rules\n\n## Readability and Simplicity first\n\nCode we write is intended to be public.\nAvoid one-liners from hell and keep code complexity under control.\nTry to make code self-explanatory and add comments if needed.\nLeave references to standards that you are implementing.\nUse project wiki to document new/reverse engineered standards.\n\n## Variable and function names must clearly define what it's doing\n\nIt's ok if it will be long, but it should clearly state what it's doing, without need to dive into code.\nThis also applies to function/method's code.\nTry to avoid one letter variables.\n\n## Encapsulation\n\nDon't expose raw data, provide methods to work with it.\nAlmost everything in flipper firmware is built around this concept.\n\n# C coding style\n\n- Tab is 4 spaces\n- Use `./fbt format` to reformat source code and check style guide before commit\n\n## Naming\n\n### Type names are PascalCase\n\nExamples:\n\n\tFuriHalUsb\n\tGui\n\tSubGhzKeystore\n\n\n### Functions are snake_case\n\n\tfuri_hal_usb_init\n\tgui_add_view_port\n\tsubghz_keystore_read\n\n### File and Package name is a prefix for it's content\n\nThis rule makes easier to locate types, functions and sources.\n\nFor example:\n\nWe have abstraction that we call `SubGhz Keystore`, so there will be:\nfile `subghz_keystore.h` we have type `SubGhzKeystore` and function `subghz_keystore_read`.\n\n### File names\n\n- Directories: `^[0-9A-Za-z_]+$`\n- File names: `^[0-9A-Za-z_]+\\.[a-z]+$`\n- File extensions: `[ \".h\", \".c\", \".cpp\", \".cxx\", \".hpp\" ]`\n\nEnforced by linter.\n\n### Standard function/method names\n\nSuffixes:\n\n- `alloc` - allocate and init instance. C style constructor. Returns pointer to instance.\n- `free` - de-init and release instance. C style destructor. Takes pointer to instance.\n\n# C++ coding style\n\nWork In Progress. Use C style guide as a base.\n\n# Python coding style\n\n- Tab is 4 spaces\n- Use [black](https://pypi.org/project/black/) to reformat source code before commit\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Welcome to FlipperZero contributing guide \n\nThank you for investing your time in contributing to our project! \n\nRead our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable.\n\nIn this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.\n\n## New contributor guide\n\nSee the [ReadMe](ReadMe.md) to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution:\n\n- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)\n- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)\n- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)\n- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)\n\n## Getting started\n\nBefore writing code and creating PR make sure that it aligns with our mission and guidelines:\n\n- All our devices are intended for research and education.\n- PR that contains code intended to commit crimes is not going to be accepted.\n- Your PR must comply with our [Coding Style](CODING_STYLE.md)\n- Your PR must contain code compatible with project [LICENSE](LICENSE).\n- PR will only be merged if it passes CI/CD.\n- PR will only be merged if it passes review by code owner.\n\nFeel free to ask questions in issues if you're not sure.\n\n### Issues\n\n#### Create a new issue\n\nIf you found a problem, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/flipperdevices/flipperzero-firmware/issues/new/choose). \n\n#### Solve an issue\n\nScan through our [existing issues](https://github.com/flipperdevices/flipperzero-firmware/issues) to find one that interests you.\n\n### Make Changes\n\n1. Fork the repository.\n- Using GitHub Desktop:\n - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.\n - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!\n\n- Using the command line:\n - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.\n\n2. Install build requirements\n\n3. Create a working branch and start with your changes!\n\n### Commit your update\n\nCommit the changes once you are happy with them. Make sure that code compilation is not broken and passes tests. Check syntax and formatting.\n\n### Pull Request\n\nWhen you're done making the changes, open a pull request, often referred to as a PR. \n- Fill out the \"Ready for review\" template, so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. \n- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.\n- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.\nOnce you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.\n- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.\n- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).\n- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.\n\n### Your PR is merged!\n\nCongratulations :tada::tada: The FlipperDevices team thanks you :sparkles:.\n"
},
{
"path": "LICENSE",
"content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n"
},
{
"path": "ReadMe.md",
"content": "\n \n \n \n\n\n# Flipper Zero Firmware\n\n- [Flipper Zero Official Website](https://flipperzero.one). A simple way to explain to your friends what Flipper Zero can do.\n- [Flipper Zero Firmware Update](https://flipperzero.one/update). Improvements for your dolphin: latest firmware releases, upgrade tools for PC and mobile devices.\n- [User Documentation](https://docs.flipper.net). Learn more about your dolphin: specs, usage guides, and anything you want to ask.\n- [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen). Dive into the Flipper Zero Firmware source code: build system, firmware structure, and more.\n\n# Contributing\n\nOur main goal is to build a healthy and sustainable community around Flipper, so we're open to any new ideas and contributions. We also have some rules and taboos here, so please read this page and our [Code of Conduct](/CODE_OF_CONDUCT.md) carefully.\n\n## I need help\n\nThe best place to search for answers is our [User Documentation](https://docs.flipper.net). If you can't find the answer there, check our [Discord Server](https://flipp.dev/discord) or our [Forum](https://forum.flipperzero.one/). If you want to contribute to the firmware development or modify it for your own needs, you can also check our [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen).\n\n## I want to report an issue\n\nIf you've found an issue and want to report it, please check our [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.\n\n## I want to contribute code\n\nBefore opening a PR, please confirm that your changes must be contained in the firmware. Many ideas can easily be implemented as external applications and published in the [Flipper Application Catalog](https://github.com/flipperdevices/flipper-application-catalog). If you are unsure, reach out to us on the [Discord Server](https://flipp.dev/discord) or the [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page, and we'll help you find the right place for your code.\n\nAlso, please read our [Contribution Guide](/CONTRIBUTING.md) and our [Coding Style](/CODING_STYLE.md), and make sure your code is compatible with our [Project License](/LICENSE).\n\nFinally, open a [Pull Request](https://github.com/flipperdevices/flipperzero-firmware/pulls) and make sure that CI/CD statuses are all green.\n\n# Development\n\nFlipper Zero Firmware is written in C, with some bits and pieces written in C++ and armv7m assembly languages. An intermediate level of C knowledge is recommended for comfortable programming. C, C++, and armv7m assembly languages are supported for Flipper applications.\n\n# Firmware RoadMap\n\n[Firmware RoadMap Miro Board](https://miro.com/app/board/uXjVO_3D6xU=/)\n\n## Requirements\n\nSupported development platforms:\n\n- Windows 10+ with PowerShell and Git (x86_64)\n- macOS 12+ with Command Line tools (x86_64, arm64)\n- Ubuntu 20.04+ with build-essential and Git (x86_64)\n\nSupported in-circuit debuggers (optional but highly recommended):\n\n- [Flipper Zero Wi-Fi Development Board](https://shop.flipperzero.one/products/wifi-devboard)\n- CMSIS-DAP compatible: Raspberry Pi Debug Probe and etc...\n- ST-Link (v2, v3, v3mods)\n- J-Link\n\nFlipper Build System will take care of all the other dependencies.\n\n## Cloning source code\n\nMake sure you have enough space and clone the source code:\n\n```shell\ngit clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git\n```\n\n## Building\n\nBuild firmware using Flipper Build Tool:\n\n```shell\n./fbt\n```\n\n## Flashing firmware using an in-circuit debugger\n\nConnect your in-circuit debugger to your Flipper and flash firmware using Flipper Build Tool:\n\n```shell\n./fbt flash\n```\n\n## Flashing firmware using USB\n\nMake sure your Flipper is on, and your firmware is functioning. Connect your Flipper with a USB cable and flash firmware using Flipper Build Tool:\n\n```shell\n./fbt flash_usb\n```\n\n## Documentation\n\n- [Flipper Build Tool](/documentation/fbt.md) - building, flashing, and debugging Flipper software\n- [Applications](/documentation/AppsOnSDCard.md), [Application Manifest](/documentation/AppManifests.md) - developing, building, deploying, and debugging Flipper applications\n- [Hardware combos and Un-bricking](/documentation/KeyCombo.md) - recovering your Flipper from the most nasty situations\n- [Flipper File Formats](/documentation/file_formats) - everything about how Flipper stores your data and how you can work with it\n- [Universal Remotes](/documentation/UniversalRemotes.md) - contributing your infrared remote to the universal remote database\n- [Firmware Roadmap](https://miro.com/app/board/uXjVO_3D6xU=/)\n- And much more in the [Developer Documentation](https://developer.flipper.net/flipperzero/doxygen)\n\n# Project structure\n\n- `applications` - Applications and services used in firmware\n- `applications_users` - Place for your additional applications and services\n- `assets` - Assets used by applications and services\n- `documentation` - Documentation generation system configs and input files\n- `furi` - Furi Core: OS-level primitives and helpers\n- `lib` - Our and 3rd party libraries, drivers, tools and etc...\n- `site_scons` - Build system configuration and modules\n- `scripts` - Supplementary scripts and various python libraries\n- `targets` - Firmware targets: platform specific code\n\nAlso, see `ReadMe.md` files inside those directories for further details.\n\n# Links\n\n- Discord: [flipp.dev/discord](https://flipp.dev/discord)\n- Website: [flipperzero.one](https://flipperzero.one)\n- Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)\n- Kickstarter: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)\n\n## SAST Tools\n\n- [PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.\n"
},
{
"path": "SConstruct",
"content": "#\n# Main Flipper Build System entry point\n#\n# This file is evaluated by scons (the build system) every time fbt is invoked.\n# Scons constructs all referenced environments & their targets' dependency\n# trees on startup. So, to keep startup time as low as possible, we're hiding\n# construction of certain targets behind command-line options.\n\nimport os\nfrom fbt.util import open_browser_action\n\nDefaultEnvironment(tools=[])\n\nEnsurePythonVersion(3, 8)\n\n# Progress([\"OwO\\r\", \"owo\\r\", \"uwu\\r\", \"owo\\r\"], interval=15)\n\n# This environment is created only for loading options & validating file/dir existence\nfbt_variables = SConscript(\"site_scons/commandline.scons\")\ncmd_environment = Environment(\n toolpath=[\"#/scripts/fbt_tools\"],\n tools=[\n (\"fbt_help\", {\"vars\": fbt_variables}),\n ],\n variables=fbt_variables,\n)\n\n# Building basic environment - tools, utility methods, cross-compilation\n# settings, gcc flags for Cortex-M4, basic builders and more\ncoreenv = SConscript(\n \"site_scons/environ.scons\",\n exports={\"VAR_ENV\": cmd_environment},\n toolpath=[\"#/scripts/fbt_tools\"],\n)\nSConscript(\"site_scons/cc.scons\", exports={\"ENV\": coreenv})\n\n# Create a separate \"dist\" environment and add construction envs to it\ndistenv = coreenv.Clone(\n tools=[\n \"fbt_dist\",\n \"fbt_debugopts\",\n \"openocd\",\n \"blackmagic\",\n \"jflash\",\n \"doxygen\",\n \"textfile\",\n ],\n ENV=os.environ,\n UPDATE_BUNDLE_DIR=\"dist/${DIST_DIR}/f${TARGET_HW}-update-${DIST_SUFFIX}\",\n)\n\nfirmware_env = distenv.AddFwProject(\n base_env=coreenv,\n fw_type=\"firmware\",\n fw_env_key=\"FW_ENV\",\n)\n\n# If enabled, initialize updater-related targets\nif GetOption(\"fullenv\") or any(\n filter(lambda target: \"updater\" in target or \"flash_usb\" in target, BUILD_TARGETS)\n):\n updater_env = distenv.AddFwProject(\n base_env=coreenv,\n fw_type=\"updater\",\n fw_env_key=\"UPD_ENV\",\n )\n\n # Target for self-update package\n dist_basic_arguments = [\n \"${ARGS}\",\n \"--bundlever\",\n \"${UPDATE_VERSION_STRING}\",\n ]\n dist_radio_arguments = [\n \"--radio\",\n \"${ROOT_DIR.abspath}/${COPRO_STACK_BIN_DIR}/${COPRO_STACK_BIN}\",\n \"--radiotype\",\n \"${COPRO_STACK_TYPE}\",\n \"${COPRO_DISCLAIMER}\",\n \"--obdata\",\n \"${ROOT_DIR.abspath}/${COPRO_OB_DATA}\",\n \"--stackversion\",\n \"${COPRO_CUBE_VERSION}\",\n ]\n dist_resource_arguments = [\n \"-r\",\n firmware_env.subst(\"${RESOURCES_ROOT}\"),\n ]\n dist_splash_arguments = (\n [\n \"--splash\",\n distenv.subst(\"assets/slideshow/$UPDATE_SPLASH\"),\n ]\n if distenv[\"UPDATE_SPLASH\"]\n else []\n )\n\n selfupdate_dist = distenv.DistCommand(\n \"updater_package\",\n (distenv[\"DIST_DEPENDS\"], firmware_env[\"FW_RESOURCES_MANIFEST\"]),\n DIST_EXTRA=[\n *dist_basic_arguments,\n *dist_radio_arguments,\n *dist_resource_arguments,\n *dist_splash_arguments,\n ],\n )\n\n selfupdate_min_dist = distenv.DistCommand(\n \"updater_minpackage\",\n distenv[\"DIST_DEPENDS\"],\n DIST_EXTRA=dist_basic_arguments,\n )\n\n # Updater debug\n distenv.PhonyTarget(\n \"updater_debug\",\n \"${GDBPYCOM}\",\n source=updater_env[\"FW_ELF\"],\n GDBREMOTE=\"${OPENOCD_GDB_PIPE}\",\n )\n\n distenv.PhonyTarget(\n \"updater_blackmagic\",\n \"${GDBPYCOM}\",\n source=updater_env[\"FW_ELF\"],\n GDBOPTS=distenv.subst(\"$GDBOPTS_BLACKMAGIC\"),\n GDBREMOTE=\"${BLACKMAGIC_ADDR}\",\n )\n\n # Installation over USB & CLI\n usb_update_package = distenv.AddUsbFlashTarget(\n \"#build/usbinstall.flag\",\n (firmware_env[\"FW_RESOURCES_MANIFEST\"], selfupdate_dist),\n )\n distenv.Alias(\"flash_usb_full\", usb_update_package)\n\n usb_minupdate_package = distenv.AddUsbFlashTarget(\n \"#build/minusbinstall.flag\", (selfupdate_min_dist,)\n )\n distenv.Alias(\"flash_usb\", usb_minupdate_package)\n\n\n# Target for copying & renaming binaries to dist folder\nbasic_dist = distenv.DistCommand(\"fw_dist\", distenv[\"DIST_DEPENDS\"])\ndistenv.Default(basic_dist)\n\ndist_dir_name = distenv.GetProjetDirName()\ndist_dir = distenv.Dir(f\"#/dist/{dist_dir_name}\")\nexternal_apps_artifacts = firmware_env[\"FW_EXTAPPS\"]\nexternal_app_list = external_apps_artifacts.application_map.values()\n\nfap_dist = [\n distenv.Install(\n dist_dir.Dir(\"debug_elf\"),\n list(app_artifact.debug for app_artifact in external_app_list),\n ),\n *(\n distenv.Install(\n dist_dir.File(dist_entry[1]).dir,\n app_artifact.compact,\n )\n for app_artifact in external_app_list\n for dist_entry in app_artifact.dist_entries\n ),\n]\nDepends(\n fap_dist,\n list(app_artifact.validator for app_artifact in external_app_list),\n)\nAlias(\"fap_dist\", fap_dist)\n\n# Copy all faps to device\n\nfap_deploy = distenv.PhonyTarget(\n \"fap_deploy\",\n Action(\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/storage.py\",\n \"-p\",\n \"${FLIP_PORT}\",\n \"send\",\n \"${SOURCE}\",\n \"/ext/apps\",\n \"${ARGS}\",\n ]\n ]\n ),\n source=firmware_env.Dir((\"${RESOURCES_ROOT}/apps\")),\n)\nDepends(fap_deploy, firmware_env[\"FW_RESOURCES_MANIFEST\"])\n\n\n# Target for bundling core2 package for qFlipper\ncopro_dist = distenv.CoproBuilder(\n \"#/build/core2_firmware.tgz\",\n [],\n)\ndistenv.AlwaysBuild(copro_dist)\ndistenv.Alias(\"copro_dist\", copro_dist)\n\n\nfirmware_flash = distenv.AddFwFlashTarget(firmware_env)\ndistenv.Alias(\"flash\", firmware_flash)\n\n# To be implemented in fwflash.py\nfirmware_jflash = distenv.AddJFlashTarget(firmware_env)\ndistenv.Alias(\"jflash\", firmware_jflash)\n\ndistenv.PhonyTarget(\n \"gdb_trace_all\",\n [[\"${GDB}\", \"${GDBOPTS}\", \"${SOURCES}\", \"${GDBFLASH}\"]],\n source=firmware_env[\"FW_ELF\"],\n GDBOPTS=\"${GDBOPTS_BASE}\",\n GDBREMOTE=\"${OPENOCD_GDB_PIPE}\",\n GDBFLASH=[\n \"-ex\",\n \"thread apply all bt\",\n \"-ex\",\n \"quit\",\n ],\n)\n\n# Debugging firmware\nfirmware_debug = distenv.PhonyTarget(\n \"debug\",\n \"${GDBPYCOM}\",\n source=firmware_env[\"FW_ELF\"],\n GDBOPTS=\"${GDBOPTS_BASE}\",\n GDBREMOTE=\"${OPENOCD_GDB_PIPE}\",\n FBT_FAP_DEBUG_ELF_ROOT=firmware_env[\"FBT_FAP_DEBUG_ELF_ROOT\"],\n)\ndistenv.Depends(firmware_debug, firmware_flash)\n\nfirmware_blackmagic = distenv.PhonyTarget(\n \"blackmagic\",\n \"${GDBPYCOM}\",\n source=firmware_env[\"FW_ELF\"],\n GDBOPTS=\"${GDBOPTS_BASE} ${GDBOPTS_BLACKMAGIC}\",\n GDBREMOTE=\"${BLACKMAGIC_ADDR}\",\n FBT_FAP_DEBUG_ELF_ROOT=firmware_env[\"FBT_FAP_DEBUG_ELF_ROOT\"],\n)\ndistenv.Depends(firmware_blackmagic, firmware_flash)\n\n# Debug alien elf\ndebug_other_opts = [\n \"-ex\",\n \"source ${FBT_DEBUG_DIR}/PyCortexMDebug/PyCortexMDebug.py\",\n # \"-ex\",\n # \"source ${FBT_DEBUG_DIR}/FreeRTOS/FreeRTOS.py\",\n \"-ex\",\n \"source ${FBT_DEBUG_DIR}/flipperversion.py\",\n \"-ex\",\n \"fw-version\",\n]\n\ndistenv.PhonyTarget(\n \"debug_other\",\n \"${GDBPYCOM}\",\n GDBOPTS=\"${GDBOPTS_BASE}\",\n GDBREMOTE=\"${OPENOCD_GDB_PIPE}\",\n GDBPYOPTS=debug_other_opts,\n)\n\ndistenv.PhonyTarget(\n \"debug_other_blackmagic\",\n \"${GDBPYCOM}\",\n GDBOPTS=\"${GDBOPTS_BASE} ${GDBOPTS_BLACKMAGIC}\",\n GDBREMOTE=\"${BLACKMAGIC_ADDR}\",\n GDBPYOPTS=debug_other_opts,\n)\n\n\n# Just start OpenOCD\ndistenv.PhonyTarget(\n \"openocd\",\n [[\"${OPENOCDCOM}\", \"${ARGS}\"]],\n)\n\n# Linter\ndistenv.PhonyTarget(\n \"lint\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/lint.py\",\n \"check\",\n \"${LINT_SOURCES}\",\n \"${ARGS}\",\n ]\n ],\n LINT_SOURCES=[n.srcnode() for n in firmware_env[\"LINT_SOURCES\"]],\n)\n\ndistenv.PhonyTarget(\n \"format\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/lint.py\",\n \"format\",\n \"${LINT_SOURCES}\",\n \"${ARGS}\",\n ]\n ],\n LINT_SOURCES=[n.srcnode() for n in firmware_env[\"LINT_SOURCES\"]],\n)\n\n# PY_LINT_SOURCES contains recursively-built modules' SConscript files\n# Here we add additional Python files residing in repo root\nfirmware_env.Append(\n PY_LINT_SOURCES=[\n # Py code folders\n \"site_scons\",\n \"scripts\",\n \"applications\",\n \"applications_user\",\n \"assets\",\n \"targets\",\n # Extra files\n \"SConstruct\",\n \"firmware.scons\",\n \"fbt_options.py\",\n ],\n IMG_LINT_SOURCES=[\n # Image assets\n \"applications\",\n \"assets\",\n ],\n)\n\n\nblack_commandline = [\n [\n \"@${PYTHON3}\",\n \"-m\",\n \"black\",\n \"${PY_BLACK_ARGS}\",\n \"${PY_LINT_SOURCES}\",\n \"${ARGS}\",\n ]\n]\nblack_base_args = [\n \"--include\",\n '\"(\\\\.scons|\\\\.py|SConscript|SConstruct|\\\\.fam)$\"',\n]\n\ndistenv.PhonyTarget(\n \"lint_py\",\n black_commandline,\n PY_BLACK_ARGS=[\n \"--check\",\n \"--diff\",\n *black_base_args,\n ],\n PY_LINT_SOURCES=firmware_env[\"PY_LINT_SOURCES\"],\n)\n\ndistenv.PhonyTarget(\n \"format_py\",\n black_commandline,\n PY_BLACK_ARGS=black_base_args,\n PY_LINT_SOURCES=firmware_env[\"PY_LINT_SOURCES\"],\n)\n\n# Image assets linting\ndistenv.PhonyTarget(\n \"lint_img\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/imglint.py\",\n \"check\",\n \"${IMG_LINT_SOURCES}\",\n \"${ARGS}\",\n ]\n ],\n IMG_LINT_SOURCES=firmware_env[\"IMG_LINT_SOURCES\"],\n)\n\ndistenv.PhonyTarget(\n \"format_img\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/imglint.py\",\n \"format\",\n \"${IMG_LINT_SOURCES}\",\n \"${ARGS}\",\n ]\n ],\n IMG_LINT_SOURCES=firmware_env[\"IMG_LINT_SOURCES\"],\n)\n\ndistenv.Alias(\"lint_all\", [\"lint\", \"lint_py\", \"lint_img\"])\ndistenv.Alias(\"format_all\", [\"format\", \"format_py\", \"format_img\"])\n\n\n# Start Flipper CLI via PySerial's miniterm\ndistenv.PhonyTarget(\n \"cli\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/serial_cli.py\",\n \"-p\",\n \"${FLIP_PORT}\",\n \"${ARGS}\",\n ]\n ],\n)\n\n\n# Measure CLI loopback performance\ndistenv.PhonyTarget(\n \"cli_perf\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/serial_cli_perf.py\",\n \"-p\",\n \"${FLIP_PORT}\",\n \"${ARGS}\",\n ]\n ],\n)\n\n# Update WiFi devboard firmware with release channel\ndistenv.PhonyTarget(\n \"devboard_flash\",\n [\n [\n \"${PYTHON3}\",\n \"${FBT_SCRIPT_DIR}/wifi_board.py\",\n \"${ARGS}\",\n ]\n ],\n)\n\n\n# Find blackmagic probe\ndistenv.PhonyTarget(\n \"get_blackmagic\",\n \"@echo $( ${BLACKMAGIC_ADDR} $)\",\n)\n\n\n# Find STLink probe ids\ndistenv.PhonyTarget(\n \"get_stlink\",\n distenv.Action(\n lambda **_: distenv.GetDevices(),\n None,\n ),\n)\n\n# Prepare vscode environment\nvscode_dist = distenv.Install(\n \"#.vscode\",\n [\n distenv.Glob(\"#.vscode/example/*.json\", exclude=\"*.tmpl\"),\n distenv.Glob(\"#.vscode/example/${LANG_SERVER}/*.json\"),\n ],\n)\nfor template_file in distenv.Glob(\"#.vscode/example/*.tmpl\"):\n vscode_dist.append(\n distenv.Substfile(\n distenv.Dir(\"#.vscode\").File(template_file.name.replace(\".tmpl\", \"\")),\n template_file,\n SUBST_DICT={\n \"@FBT_PLATFORM_EXECUTABLE_EXT@\": \".exe\" if os.name == \"nt\" else \"\"\n },\n )\n )\ndistenv.Precious(vscode_dist)\ndistenv.NoClean(vscode_dist)\ndistenv.Alias(\"vscode_dist\", (vscode_dist, firmware_env[\"FW_CDB\"]))\n\n# Configure shell with build tools\ndistenv.PhonyTarget(\n \"env\",\n \"@echo $( ${FBT_SCRIPT_DIR.abspath}/toolchain/fbtenv.sh $)\",\n)\n\ndoxy_build = distenv.DoxyBuild(\n \"documentation/doxygen/build/html/index.html\",\n \"documentation/doxygen/Doxyfile-awesome.cfg\",\n doxy_env_variables={\n \"DOXY_SRC_ROOT\": Dir(\".\").abspath,\n \"DOXY_BUILD_DIR\": Dir(\"documentation/doxygen/build\").abspath,\n \"DOXY_CONFIG_DIR\": \"documentation/doxygen\",\n },\n)\ndistenv.Alias(\"doxygen\", doxy_build)\ndistenv.AlwaysBuild(doxy_build)\n\n# Open generated documentation in browser\ndistenv.PhonyTarget(\"doxy\", open_browser_action, source=doxy_build)\n"
},
{
"path": "applications/ReadMe.md",
"content": "# Structure\n\n## debug \n\nApplications for factory testing the Flipper.\n\n- `accessor` - Wiegand server \n- `battery_test_app` - Battery debug app\n- `blink_test` - LED blinker \n- `bt_debug_app` - BT test app. Requires full BT stack installed\n- `display_test` - Various display tests & tweaks\n- `file_browser_test` - Test UI for file picker\n- `keypad_test` - Keypad test\n- `lfrfid_debug` - LF RFID debug tool\n- `text_box_test` - UI tests\n- `uart_echo` - UART mode test \n- `unit_tests` - Unit tests\n- `usb_mouse` - USB HID test\n- `usb_test` - Other USB tests\n- `vibro_test` - Vibro test\n\n\n## main\n\nApplications for main Flipper menu.\n\n- `archive` - Archive and file manager \n- `bad_usb` - Bad USB application\n- `gpio` - GPIO application: includes USART bridge and GPIO control\n- `ibutton` - iButton application, onewire keys and more\n- `infrared` - Infrared application, controls your IR devices\n- `lfrfid` - LF RFID application\n- `nfc` - NFC application, HF rfid, EMV and etc\n- `subghz` - SubGhz application, 433 fobs and etc\n- `u2f` - U2F Application\n\n\n## services\n\nBackground services providing system APIs to applications.\n\n- `applications.h` - Firmware application list header\n\n- `bt` - BLE service and application\n- `cli` - Console service and API\n- `crypto` - Crypto cli tools\n- `desktop` - Desktop service\n- `dialogs` - Dialogs service: GUI Dialogs for your app\n- `dolphin` - Dolphin service and supplementary apps\n- `gui` - GUI service and API\n- `input` - Input service\n- `loader` - Application loader service\n- `notification` - Notification service \n- `power` - Power service\n- `rpc` - RPC service and API\n- `storage` - Storage service, internal + sdcard\n\n\n## settings\n\nSmall applications providing configuration for basic firmware and its services.\n\n- `about` - Small About application that shows flipper info\n- `bt_settings_app` - Bluetooth options\n- `desktop_settings` - Desktop configuration\n- `dolphin_passport` - Dolphin passport app\n- `notification_settings` - LCD brightness, sound volume, etc configuration\n- `power_settings_app` - Basic power options\n- `storage_settings` - Storage settings app\n- `system` - System settings\n\n\n## system\n\nUtility apps not visible in other menus, plus few external apps pre-packaged with the firmware.\n\n- `hid_app` - BLE & USB HID remote\n- `js_app` - JS engine runner\n- `snake_game` - Snake game\n- `storage_move_to_sd` - Data migration tool for internal storage\n- `updater` - Update service & application\n"
},
{
"path": "applications/debug/accessor/accessor.cpp",
"content": "#include \"accessor_app.h\"\n\n// app enter function\nextern \"C\" int32_t accessor_app(void* p) {\n UNUSED(p);\n AccessorApp* app = new AccessorApp();\n app->run();\n delete app;\n\n return 255;\n}\n"
},
{
"path": "applications/debug/accessor/accessor_app.cpp",
"content": "#include \"accessor_app.h\"\n#include \n#include \n#include \n#include \n\nvoid AccessorApp::run(void) {\n AccessorEvent event;\n bool consumed;\n bool exit = false;\n\n wiegand.begin();\n onewire_host_start(onewire_host);\n\n scenes[current_scene]->on_enter(this);\n\n while(!exit) {\n view.receive_event(&event);\n\n consumed = scenes[current_scene]->on_event(this, &event);\n\n if(!consumed) {\n if(event.type == AccessorEvent::Type::Back) {\n exit = switch_to_previous_scene();\n }\n }\n };\n\n scenes[current_scene]->on_exit(this);\n\n wiegand.end();\n onewire_host_stop(onewire_host);\n}\n\nAccessorApp::AccessorApp()\n : text_store{0} {\n notification = static_cast(furi_record_open(RECORD_NOTIFICATION));\n expansion = static_cast(furi_record_open(RECORD_EXPANSION));\n power = static_cast(furi_record_open(RECORD_POWER));\n onewire_host = onewire_host_alloc(&gpio_ibutton);\n expansion_disable(expansion);\n power_enable_otg(power, true);\n}\n\nAccessorApp::~AccessorApp() {\n power_enable_otg(power, false);\n expansion_enable(expansion);\n furi_record_close(RECORD_EXPANSION);\n furi_record_close(RECORD_NOTIFICATION);\n furi_record_close(RECORD_POWER);\n onewire_host_free(onewire_host);\n}\n\nAccessorAppViewManager* AccessorApp::get_view_manager() {\n return &view;\n}\n\nvoid AccessorApp::switch_to_next_scene(Scene next_scene) {\n previous_scenes_list.push_front(current_scene);\n\n if(next_scene != Scene::Exit) {\n scenes[current_scene]->on_exit(this);\n current_scene = next_scene;\n scenes[current_scene]->on_enter(this);\n }\n}\n\nvoid AccessorApp::search_and_switch_to_previous_scene(std::initializer_list scenes_list) {\n Scene previous_scene = Scene::Start;\n bool scene_found = false;\n\n while(!scene_found) {\n previous_scene = get_previous_scene();\n for(Scene element : scenes_list) {\n if(previous_scene == element || previous_scene == Scene::Start) {\n scene_found = true;\n break;\n }\n }\n }\n\n scenes[current_scene]->on_exit(this);\n current_scene = previous_scene;\n scenes[current_scene]->on_enter(this);\n}\n\nbool AccessorApp::switch_to_previous_scene(uint8_t count) {\n Scene previous_scene = Scene::Start;\n\n for(uint8_t i = 0; i < count; i++) {\n previous_scene = get_previous_scene();\n if(previous_scene == Scene::Exit) break;\n }\n\n if(previous_scene == Scene::Exit) {\n return true;\n } else {\n scenes[current_scene]->on_exit(this);\n current_scene = previous_scene;\n scenes[current_scene]->on_enter(this);\n return false;\n }\n}\n\nAccessorApp::Scene AccessorApp::get_previous_scene() {\n Scene scene = previous_scenes_list.front();\n previous_scenes_list.pop_front();\n return scene;\n}\n\n/***************************** NOTIFY *******************************/\n\nvoid AccessorApp::notify_green_blink() {\n notification_message(notification, &sequence_blink_green_10);\n}\n\nvoid AccessorApp::notify_success() {\n notification_message(notification, &sequence_success);\n}\n\n/*************************** TEXT STORE *****************************/\n\nchar* AccessorApp::get_text_store() {\n return text_store;\n}\n\nuint8_t AccessorApp::get_text_store_size() {\n return text_store_size;\n}\n\nvoid AccessorApp::set_text_store(const char* text...) {\n va_list args;\n va_start(args, text);\n\n vsnprintf(text_store, text_store_size, text, args);\n\n va_end(args);\n}\n\n/*************************** APP RESOURCES *****************************/\n\nWIEGAND* AccessorApp::get_wiegand() {\n return &wiegand;\n}\n\nOneWireHost* AccessorApp::get_one_wire() {\n return onewire_host;\n}\n"
},
{
"path": "applications/debug/accessor/accessor_app.h",
"content": "#pragma once\n#include