Mirrors/unleashed-firmware
2
0
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware synced 2024-11-10 06:54:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
unleashed-firmware/documentation/MultiConverter.md
Round-Pi b89902942b typo combing
2023-02-20 10:55:53 -05:00

3.7 KiB
Raw Blame History

MultiConverter

Author: theisolinearchip

An expanded version of my previous Dec/Hex Converter, this time allowing more units and a (probably poorly made from a design-point-of-view) selector mode to swap between different unit groups.

I wrote it with the idea of expanding the unit list on mind, so adding new ones it's a matter of increasing an array of constants + defining the proper conversion functions.

(Actually the whole project is more about "making the framework" rather than providing ALL of the possible units : D)

Img 1 Img 2

Current conversions

  • Decimal / Hexadecimal / Binary
  • Celsius / Fahrenheit / Kelvin
  • Kilometers / Meters / Centimeters / Miles / Feet / Inches
  • Degree / Radian

Usage

Base keyboard allows numbers from 0 to F, being disabled (or not) according to the current selected unit.

Long press on 0 toggles a negative value; long press on 1 sets a decimal point (only if allowed by the current selected unit).

< removes the last character; # changes to Unit Select Mode.

Unit Select Mode

Left and Right to swap between origin unit and destination unit (notice the destination will change according to the current selected origin).

Ok to save the changes and go back to the Display Mode; Back to go back without changing any unit.

Adding new units

  1. Add the new units in the MultiConverterUnitType enum on multi_converter_definitions.h (basic definitions header). Notice each enum element will be used as an array index later.

  2. Increase the MULTI_CONVERTER_AVAILABLE_UNITS constant on multi_converter_units.h (units main header file).

  3. Set a pair of functions for converting units and to check if a target unit is allowed to work with the destination unit (both on multi_converter_units.h and multi_converter_units.c; follow the already built-in units for more info).

  4. Add the proper MultiConverterUnit structs for each new unit.

  5. Add each new struct to the main multi_converter_available_units array.

And that's it! The system will fetch the new units and display it!

Known issues, TODO-list, etc.

This is an initial release, so expect some bugs and issues (also I don't work with C that much, so there're probably lots of things that can be improved and/or changed!).

  • I've noticed some small decimal variations when "going deep" with some units (like converting miles to centimeters and things like that); probably due to the precision-level required. Need to check that.
  • Pending: improve overflow checks.
  • The way some long numbers are shown could probably be improved to look fancier.
  • Both origin and destination buffers are the same. The destination one could probably be longer in order to avoid certain overflow scenarios.
  • The GUI needs improvement too: there's a whole widget/views system built in the Flipper that allows things like setting up keys, showing "Save/Back/Cancel" messages with callbacks and stuff like that. Didn't know anything about them, so I moved on with something more basic (which is probably fine since it's not a "very big project"); but a more "standard" way with the regular GUI stuff provided by the firmware will be interesting...
  • More GUI stuff: the long click buttons for adding a decimal point / negative number aren't very clear on the view itself (I tried to add a small dot / dash symbol, but I think those are small enough to be a little bit confusing)