Skip to content

Commit

Permalink
FlipLibrary v1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jblanked committed Oct 17, 2024
0 parents commit 3f53e21
Show file tree
Hide file tree
Showing 22 changed files with 4,350 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## v1.0
- Initial Release
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 jblanked

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
The **FlipLibrary** app for Flipper Zero is a versatile and user-friendly application that offers a combination of useful features to enhance your Flipper Zero experience.

The app includes a **dictionary**, **random facts**, and additional functionalities, all accessible directly from your Flipper Zero device. It is designed for easy navigation and quick access to information, making it a handy companion for on-the-go learning and entertainment.

FlipLibrary uses the FlipperHTTP flash for the WiFi Devboard, first introduced in the WebCrawler app: https://github.com/jblanked/WebCrawler-FlipperZero/tree/main/assets/FlipperHTTP

## Features
- **Dictionary**: Look up definitions of words directly on your Flipper Zero. Simply enter a word, and the app will provide its definition, making it easy to learn new vocabulary or clarify meaning.
- **Random Facts**: Discover interesting and fun facts to share with friends or expand your general knowledge. The app offers various categories of facts, such as facts about cats or completely random trivia.
- **WiFi Settings Management**: Configure and manage WiFi settings (SSID and password) for future app updates that may utilize network connectivity.

## Navigation
- **Main Menu**: The main entry point for accessing all of the app's features. Options include:
- **Random Fact**: Displays a random fact from a selected category.
- **Dictionary**: Allows you to enter a word and view its definition.
- **About**: Information about the app and its version.
- **WiFi Settings**: Configure and view saved WiFi settings.

## Setup
The app automatically allocates necessary resources and initializes settings. If previously saved WiFi settings exist, they are loaded and displayed in the settings section.

## How to Use
1. **Flash**: Flash your WiFi Devboard: https://github.com/jblanked/WebCrawler-FlipperZero/tree/main/assets/FlipperHTTP
2. **Install**: Install the app from the App Store.
3. **Launch**: Open the FlipLibrary app.
4. **Navigate**:
- Use the **Dictionary** section to look up word definitions.
- Visit **Random Facts** to read interesting trivia.
- Configure **WiFi settings** if network-related features are required in the future.
- Check the **About** section to learn more about the app.
37 changes: 37 additions & 0 deletions app.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#include <flip_library_e.h>
#include <flip_library_storage.h>
#include <flip_library_callback.h>
#include <flip_library_i.h>
#include <flip_library_free.h>

// Entry point for the FlipLibrary application
int32_t flip_library_app(void *p)
{
// Suppress unused parameter warning
UNUSED(p);

// Initialize the FlipLibrary application
FlipLibraryApp *app = flip_library_app_alloc();

// send settings and connect wifi
if (!flipper_http_connect_wifi())
{
FURI_LOG_E(TAG, "Failed to connect to WiFi");
return -1;
}

if (!flipper_http_ping())
{
FURI_LOG_E(TAG, "Failed to ping the device");
return -1;
}

// Run the view dispatcher
view_dispatcher_run(app->view_dispatcher);

// Free the resources used by the FlipLibrary application
flip_library_app_free(app);

// Return 0 to indicate success
return 0;
}
Binary file added app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions application.fam
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
App(
appid="flip_library",
name="FlipLibrary",
apptype=FlipperAppType.EXTERNAL,
entry_point="flip_library_app",
stack_size=4 * 1024,
fap_icon="app.png",
fap_category="GPIO",
fap_icon_assets="assets",
fap_description="Dictionary, random facts, and more.",
fap_author="JBlanked",
fap_weburl="https://github.com/jblanked/FlipLibrary",
fap_version = "1.0",
)
Binary file added assets/KeyBackspaceSelected_16x9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/KeyBackspace_16x9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/KeySaveSelected_24x11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/KeySave_24x11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/WarningDolphin_45x42.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3f53e21

Please sign in to comment.