unleashed-firmware/applications/external/barcode_gen/README.md

89 lines
3.6 KiB
Markdown
Raw Normal View History

2023-07-05 23:26:56 +00:00
<p align="center">
<h1 align="center">Barcode Generator</h1>
<p align="center">
A barcode generator for the Flipper Zero that supports **UPC-A**, **EAN-8**, **EAN-13**, **Code-39**, **Codabar**, and **Code-128**[1]
</p>
Note: Barcode save locations have been moved from `/barcodes` to `/apps_data/barcodes`
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installing](#installing)
- [Building](#building)
- [Usage](#usage)
- [Creating a barcode](#creating-a-barcode)
- [Editing a barcode](#editing-a-barcode)
- [Deleting a barcode](#deleting-a-barcode)
- [Viewing a barcode](#viewing-a-barcode)
- [Screenshots](#screenshots)
- [Credits](#credits)
## Installing
1) Download the `.zip` file from the release section
2) Extract/unzip the `.zip` file onto your computer
3) Open qFlipper and go to the file manager
4) Navigate to the `apps` folder
5) Drag & drop the `.fap` file into the `apps` folder
6) Navigate back to the root folder of the SD card and create the folder `apps_data`, if not already there
7) Navigate into `apps_data` and create another folder called `barcode_data`
8) Navigate into `barcode_data`
9) Drag & drop the encoding txts (`code39_encodings.txt`, `code128_encodings.txt` & `codabar_encodings.txt`) into the `barcode_data` folder
## Building
1) Clone the [flipperzero-firmware](https://github.com/flipperdevices/flipperzero-firmware) repository or a firmware of your choice
2) Clone this repository and put it in the `applications_user` folder
3) Build this app by using the command `./fbt fap_Barcode_App`
4) Copy the `.fap` from `build\f7-firmware-D\.extapps\Barcode_App.fap` to `apps\Misc` using the qFlipper app
5) While still in the qFlipper app, navigate to the root folder of the SD card and create the folder `apps_data`, if not already there
6) Navigate into `apps_data` and create another folder called `barcode_data`
7) Navigate into `barcode_data`
8) Drag & drop the encoding txts (`code39_encodings.txt`, `code128_encodings.txt` & `codabar_encodings.txt`) from the `encoding_tables` folder in this repository into the `barcode_data` folder
## Usage
### Creating a barcode
1) To create a barcode click on `Create Barcode`
2) Next select your type using the left and right arrows
3) Enter your filename and then your barcode data
4) Click save
**Note**: For Codabar barcodes, you must manually add the start and stop codes to the barcode data
Start/Stop codes can be A, B, C, or D
For example, if you wanted to represent `1234` as a barcode you will need to enter something like `A1234A`. (You can replace the letters A with either A, B, C, or D)
![Codabar Data Example](screenshots/Codabar%20Data%20Example.png "Codabar Data Example")
### Editing a barcode
1) To edit a barcode click on `Edit Barcode`
2) Next select the barcode file you want to edit
3) Edit the type, name, or data
4) Click save
### Deleting a barcode
1) To delete a barcode click on `Edit Barcode`
2) Next select the barcode file you want to delete
3) Scroll all the way to the bottom
4) Click delete
### Viewing a barcode
1) To view a barcode click on `Load Barcode`
2) Next select the barcode file you want to view
## Screenshots
![Barcode Create Screen](screenshots/Creating%20Barcode.png "Barcode Create Screen")
![Flipper Code-128 Barcode](screenshots/Flipper%20Barcode.png "Flipper Code-128 Barcode")
![Flipper Box EAN-13 Barcode](screenshots/Flipper%20Box%20Barcode.png "Flipper Box EAN-13 Barcode")
## Credits
- [Kingal1337](https://github.com/Kingal1337) - Developer
- [Z0wl](https://github.com/Z0wl) - Added Code128-C Support
- [@teeebor](https://github.com/teeebor) - Menu Code Snippet
[1] - supports Set B (only the characters from 0-94). Also supports Set C