commit d6cb3b42f2d7278697ca72b86f78cf746f1e9753 Author: Davide Ferrari Date: Sun Dec 14 12:03:25 2025 +0100 feat: initial project structure with Settings screen - Set up Kotlin + Jetpack Compose Android project - Configure Gradle with version catalog and all dependencies - Implement Settings screen for TeslamateApi server configuration - Add Material Design 3 theming with Tesla-inspired colors - Set up Hilt dependency injection - Add DataStore for settings persistence - Include navigation component with Compose integration - Add GPLv3 license πŸ€– Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1bebcd --- /dev/null +++ b/.gitignore @@ -0,0 +1,93 @@ +# Kotlin +.kotlin/ + +# Built application files +*.apk +*.aar +*.ap_ +*.aab + +# Files for the ART/Dalvik VM +*.dex + +# Java class files +*.class + +# Generated files +bin/ +gen/ +out/ +release/ + +# Gradle files +.gradle/ +build/ +**/build/ + +# Local configuration file (sdk path, etc) +local.properties + +# Proguard folder generated by Eclipse +proguard/ + +# Log Files +*.log + +# Android Studio Navigation editor temp files +.navigation/ + +# Android Studio captures folder +captures/ + +# IntelliJ +*.iml +.idea/ +.idea/workspace.xml +.idea/tasks.xml +.idea/gradle.xml +.idea/assetWizardSettings.xml +.idea/dictionaries +.idea/libraries +.idea/caches +.idea/modules.xml + +# External native build folder generated in Android Studio 2.2 and later +.externalNativeBuild +.cxx/ + +# Google Services (e.g. APIs or Firebase) +google-services.json + +# Freeline +freeline.py +freeline/ +freeline_project_description.json + +# fastlane +fastlane/report.xml +fastlane/Preview.html +fastlane/screenshots +fastlane/test_output +fastlane/readme.md + +# Version control +vcs.xml + +# lint +lint/intermediates/ +lint/generated/ +lint/outputs/ +lint/tmp/ + +# Keystore files +*.jks +*.keystore + +# OS generated files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2a9e35c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,31 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Initial project structure with Kotlin and Jetpack Compose +- Settings screen for TeslamateApi server configuration +- Material Design 3 theming with Tesla-inspired colors +- Dark/light mode support with dynamic colors on Android 12+ +- DataStore for secure settings persistence +- Hilt dependency injection setup +- Navigation component with Compose integration + +## [0.1.0] - Unreleased + +Initial development release (MVP in progress). + +### Planned +- Dashboard with real-time vehicle status +- Charging history with statistics and charts +- Drive history with efficiency metrics +- Battery health tracking +- Software update history + +[Unreleased]: https://github.com/yourusername/matedroid/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/yourusername/matedroid/releases/tag/v0.1.0 diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..18235ce --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,5 @@ +RULES TO FOLLOW FOR THIS PROJECT + +* automatically commit to git any meaningful change, with a short but clear commit message +* follow the "Keep a changelog" and Semantic versioning best practices but DO NOT release major versions by yourself. Ask me if you think they might be released. +* keep an alwys up-to-dat README.md, with instructions on how to install, develop, and the application main features diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/PLAN.md b/PLAN.md new file mode 100644 index 0000000..b2f4722 --- /dev/null +++ b/PLAN.md @@ -0,0 +1,755 @@ +# MateDroid - Android App for Teslamate + +## Overview + +MateDroid is a native Android application that displays Tesla vehicle data and statistics from a self-hosted [Teslamate](https://github.com/adriankumpf/teslamate) instance via the [TeslamateApi](https://github.com/tobiasehlert/teslamateapi). + +The app provides a clean, modern interface for viewing: +- Real-time vehicle status +- Charging history and statistics +- Drive/trip history and efficiency metrics +- Battery health tracking +- Software update history + +--- + +## Technology Stack Recommendation + +### Language: **Kotlin** +- Official language for Android development since 2019 +- Concise, expressive, and null-safe +- Excellent coroutine support for async operations +- Massive documentation and LLM training data coverage + +### UI Framework: **Jetpack Compose** +- Modern declarative UI toolkit (official Google recommendation) +- Less boilerplate than XML-based layouts +- Excellent for building charts and custom visualizations +- Hot reload support for faster development +- Material Design 3 built-in + +### Build System: **Gradle (Kotlin DSL)** +- Full CLI support (`./gradlew build`, `./gradlew installDebug`) +- Works perfectly on Linux terminal +- No IDE required (though Android Studio available if wanted) + +### Networking: **Retrofit + OkHttp** +- Industry standard for REST APIs +- Kotlin coroutines integration +- Easy JSON parsing with Moshi/Kotlinx.serialization + +### Charts: **Vico** +- Modern Jetpack Compose-native charting library +- Beautiful, customizable charts +- Active development and good documentation + +### Architecture: **MVVM + Clean Architecture** +- ViewModels for UI state management +- Repository pattern for data layer +- Use cases for business logic +- Easy to test and maintain + +### Dependency Injection: **Hilt** +- Official Android DI solution +- Reduces boilerplate +- Compile-time verification + +--- + +## Development Environment Setup + +### Required Tools (Linux) + +```bash +# 1. Install Java 17 (required for Android development) +sudo apt install openjdk-17-jdk + +# 2. Install Android SDK command-line tools +# Download from: https://developer.android.com/studio#command-tools +mkdir -p ~/Android/Sdk/cmdline-tools +cd ~/Android/Sdk/cmdline-tools +unzip commandlinetools-linux-*.zip +mv cmdline-tools latest + +# 3. Set environment variables (add to ~/.bashrc or ~/.zshrc) +export ANDROID_HOME=$HOME/Android/Sdk +export PATH=$PATH:$ANDROID_HOME/cmdline-tools/latest/bin +export PATH=$PATH:$ANDROID_HOME/platform-tools + +# 4. Accept licenses and install required SDK components +sdkmanager --licenses +sdkmanager "platform-tools" "platforms;android-34" "build-tools;34.0.0" + +# 5. (Optional) Install Android Studio for visual debugging +# Download from: https://developer.android.com/studio +``` + +### CLI Workflow + +```bash +# Build the project +./gradlew build + +# Run unit tests +./gradlew test + +# Install debug APK to connected device/emulator +./gradlew installDebug + +# Create release APK +./gradlew assembleRelease + +# Lint checks +./gradlew lint +``` + +--- + +## Project Structure + +``` +matedroid/ +β”œβ”€β”€ app/ +β”‚ β”œβ”€β”€ src/ +β”‚ β”‚ β”œβ”€β”€ main/ +β”‚ β”‚ β”‚ β”œβ”€β”€ java/com/matedroid/ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ MainActivity.kt +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ MateDroidApp.kt +β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ data/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ api/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ TeslamateApi.kt # Retrofit interface +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── models/ # API response DTOs +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ repository/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── TeslamateRepository.kt +β”‚ β”‚ β”‚ β”‚ β”‚ └── local/ +β”‚ β”‚ β”‚ β”‚ β”‚ └── SettingsDataStore.kt # Local preferences +β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ domain/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ model/ # Domain models +β”‚ β”‚ β”‚ β”‚ β”‚ └── usecase/ # Business logic +β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ ui/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ theme/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ Theme.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ Color.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── Type.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ navigation/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── NavGraph.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ screens/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ dashboard/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ DashboardScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── DashboardViewModel.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ charges/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ ChargesScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ ChargeDetailScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── ChargesViewModel.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ drives/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ DrivesScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ DriveDetailScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── DrivesViewModel.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ battery/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ BatteryHealthScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── BatteryViewModel.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ updates/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── UpdatesScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── settings/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ SettingsScreen.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ └── SettingsViewModel.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ └── components/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ StatCard.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ ChargeChart.kt +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ EfficiencyChart.kt +β”‚ β”‚ β”‚ β”‚ β”‚ └── LoadingIndicator.kt +β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ └── di/ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ AppModule.kt +β”‚ β”‚ β”‚ β”‚ └── NetworkModule.kt +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”œβ”€β”€ res/ +β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ values/ +β”‚ β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ strings.xml +β”‚ β”‚ β”‚ β”‚ β”‚ └── colors.xml +β”‚ β”‚ β”‚ β”‚ └── drawable/ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ └── AndroidManifest.xml +β”‚ β”‚ β”‚ +β”‚ β”‚ └── test/ # Unit tests +β”‚ β”‚ +β”‚ └── build.gradle.kts +β”‚ +β”œβ”€β”€ gradle/ +β”œβ”€β”€ build.gradle.kts # Root build file +β”œβ”€β”€ settings.gradle.kts +β”œβ”€β”€ gradle.properties +β”œβ”€β”€ local.properties # SDK path (gitignored) +└── README.md +``` + +--- + +## TeslamateApi Integration + +### API Endpoints to Implement + +| Priority | Endpoint | Purpose | +|----------|----------|---------| +| P0 | `GET /api/v1/cars` | List vehicles (needed first) | +| P0 | `GET /api/v1/cars/:id/status` | Real-time vehicle status | +| P0 | `GET /api/v1/cars/:id/charges` | Charging history | +| P0 | `GET /api/v1/cars/:id/drives` | Drive history | +| P1 | `GET /api/v1/cars/:id/battery-health` | Battery degradation | +| P1 | `GET /api/v1/cars/:id/charges/:id` | Charge session detail | +| P1 | `GET /api/v1/cars/:id/drives/:id` | Drive detail | +| P2 | `GET /api/v1/cars/:id/updates` | Software updates | +| P2 | `POST /api/v1/cars/:id/wake_up` | Wake vehicle | +| P3 | `POST /api/v1/cars/:id/command/:cmd` | Vehicle commands | + +### Authentication + +The API supports token-based authentication: +- Header: `Authorization: Bearer ` +- Query param: `?token=` + +The app will store the API URL and token securely in encrypted SharedPreferences (DataStore). + +### Retrofit Interface + +```kotlin +interface TeslamateApi { + @GET("api/v1/cars") + suspend fun getCars(): Response + + @GET("api/v1/cars/{carId}/status") + suspend fun getCarStatus(@Path("carId") carId: Int): Response + + @GET("api/v1/cars/{carId}/charges") + suspend fun getCharges( + @Path("carId") carId: Int, + @Query("startDate") startDate: String? = null, + @Query("endDate") endDate: String? = null + ): Response + + @GET("api/v1/cars/{carId}/drives") + suspend fun getDrives( + @Path("carId") carId: Int, + @Query("startDate") startDate: String? = null, + @Query("endDate") endDate: String? = null + ): Response + + @GET("api/v1/cars/{carId}/battery-health") + suspend fun getBatteryHealth(@Path("carId") carId: Int): Response +} +``` + +--- + +## App Screens & Features + +### 1. Settings / Onboarding (First Launch) + +**Purpose:** Configure connection to TeslamateApi instance + +**UI Elements:** +- Server URL input field (e.g., `https://teslamate.example.com`) +- API Token input field (password masked) +- "Test Connection" button +- Save button + +**Behavior:** +- Validates URL format +- Tests connection with `/api/ping` +- Stores credentials in encrypted DataStore +- Navigates to Dashboard on success + +--- + +### 2. Dashboard Screen + +**Purpose:** At-a-glance vehicle status + +**UI Elements:** +- Vehicle name and image/icon +- Battery level with circular progress indicator +- Charging state (charging, not charging, plugged in) +- Current location (if available) +- Odometer reading +- Inside/outside temperature +- Last seen timestamp +- Quick stats cards: + - Today's drives (count + distance) + - This month's charges (count + kWh) + - Efficiency (Wh/km) + +**Data Source:** `GET /api/v1/cars/:id/status` + +--- + +### 3. Charges Screen + +**Purpose:** Charging history with statistics + +**UI Elements:** +- Summary card at top: + - Total charges count + - Total energy added (kWh) + - Average charge cost (if available) + - Total cost (if available) +- Filter chips: Last 7 days / 30 days / 90 days / All time +- Line chart: Energy added over time +- List of charge sessions: + - Date/time + - Location + - Energy added (kWh) + - Duration + - Cost (if available) + - Start/end battery % + +**Data Source:** `GET /api/v1/cars/:id/charges` + +**Detail Screen:** +- Full charge session details +- Charge curve chart (if data available) +- Cost breakdown + +--- + +### 4. Drives Screen + +**Purpose:** Trip history with efficiency metrics + +**UI Elements:** +- Summary card: + - Total drives count + - Total distance + - Average efficiency (Wh/km) + - Total duration +- Filter chips: Last 7 days / 30 days / 90 days / All time +- Bar chart: Daily/weekly distance +- List of drives: + - Date/time + - Start β†’ End location + - Distance + - Duration + - Efficiency (Wh/km) + - Battery used % + +**Data Source:** `GET /api/v1/cars/:id/drives` + +**Detail Screen:** +- Full drive details +- Route map (if coordinates available) +- Speed/efficiency graphs + +--- + +### 5. Battery Health Screen + +**Purpose:** Monitor battery degradation over time + +**UI Elements:** +- Current battery health percentage +- Original vs current capacity +- Line chart: Battery health over time +- Statistics: + - Total charge cycles + - Battery age + - Degradation rate + +**Data Source:** `GET /api/v1/cars/:id/battery-health` + +--- + +### 6. Software Updates Screen + +**Purpose:** Track software update history + +**UI Elements:** +- Current software version +- List of past updates: + - Version number + - Update date + - Time between updates + +**Data Source:** `GET /api/v1/cars/:id/updates` + +--- + +## Implementation Phases + +### Phase 1: Foundation (MVP) +1. βœ… Create plan document +2. Project scaffolding with Gradle +3. Implement Settings screen (server config) +4. Basic API client with Retrofit +5. Dashboard screen with vehicle status +6. Basic error handling and loading states + +**Deliverable:** App that connects to TeslamateApi and shows vehicle status + +--- + +### Phase 2: Core Features +1. Charges screen with list and summary stats +2. Drives screen with list and summary stats +3. Pull-to-refresh functionality +4. Date filtering for charges/drives +5. Detail screens for individual charges/drives + +**Deliverable:** Full browsing of charge and drive history + +--- + +### Phase 3: Visualizations +1. Integrate Vico charting library +2. Charge history line chart +3. Drive distance bar chart +4. Battery level trends +5. Efficiency trends + +**Deliverable:** Rich data visualizations + +--- + +### Phase 4: Battery & Updates +1. Battery health screen with degradation tracking +2. Software updates history screen +3. Battery health trend chart + +**Deliverable:** Complete vehicle health monitoring + +--- + +### Phase 5: Polish & Extras +1. Dark/light theme with Material You +2. Multi-vehicle support (vehicle selector) +3. Offline caching with Room database +4. Widget for home screen (battery status) +5. Notifications for charge completion (optional) +6. Vehicle commands (wake, etc.) - requires careful consideration + +**Deliverable:** Production-ready polished app + +--- + +## Dependencies (build.gradle.kts) + +```kotlin +dependencies { + // Core Android + implementation("androidx.core:core-ktx:1.12.0") + implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.7.0") + implementation("androidx.activity:activity-compose:1.8.2") + + // Compose + implementation(platform("androidx.compose:compose-bom:2024.02.00")) + implementation("androidx.compose.ui:ui") + implementation("androidx.compose.ui:ui-graphics") + implementation("androidx.compose.ui:ui-tooling-preview") + implementation("androidx.compose.material3:material3") + implementation("androidx.navigation:navigation-compose:2.7.7") + + // Networking + implementation("com.squareup.retrofit2:retrofit:2.9.0") + implementation("com.squareup.retrofit2:converter-moshi:2.9.0") + implementation("com.squareup.okhttp3:okhttp:4.12.0") + implementation("com.squareup.okhttp3:logging-interceptor:4.12.0") + implementation("com.squareup.moshi:moshi-kotlin:1.15.0") + ksp("com.squareup.moshi:moshi-kotlin-codegen:1.15.0") + + // Dependency Injection + implementation("com.google.dagger:hilt-android:2.50") + ksp("com.google.dagger:hilt-compiler:2.50") + implementation("androidx.hilt:hilt-navigation-compose:1.1.0") + + // DataStore (encrypted preferences) + implementation("androidx.datastore:datastore-preferences:1.0.0") + implementation("androidx.security:security-crypto:1.1.0-alpha06") + + // Charts + implementation("com.patrykandpatrick.vico:compose-m3:1.13.1") + + // Testing + testImplementation("junit:junit:4.13.2") + testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3") + testImplementation("io.mockk:mockk:1.13.9") + androidTestImplementation("androidx.test.ext:junit:1.1.5") + androidTestImplementation("androidx.compose.ui:ui-test-junit4") +} +``` + +--- + +## Design Guidelines + +### Visual Style +- Material Design 3 (Material You) +- Support dynamic color theming on Android 12+ +- Dark and light mode support +- Tesla-inspired color accents (red for Model S/X, blue for Model 3/Y) + +### Color Palette +``` +Primary: #E31937 (Tesla Red) +Secondary: #171A20 (Tesla Dark) +Surface: Material default +On-Surface: Material default +Accent Blue: #3E6AE1 (for Model 3/Y) +Success: #4CAF50 (battery full, charge complete) +Warning: #FF9800 (low battery) +Error: #F44336 (connection issues) +``` + +### Typography +- Roboto (Android default) +- Large numbers for key metrics +- Clear hierarchy with Material type scale + +### Icons +- Material Icons (filled style) +- Custom battery/charging icons where needed + +--- + +## Security Considerations + +1. **Token Storage:** Use EncryptedSharedPreferences via AndroidX Security +2. **Network Security:** Enforce HTTPS (network security config) +3. **No Sensitive Logging:** Mask tokens in debug logs +4. **Certificate Pinning:** Optional for self-hosted instances + +--- + +## Testing Strategy + +Testing will be set up from Phase 1 and expanded as features are added. + +### Unit Tests (src/test/) +**What:** Test business logic in isolation without Android framework + +| Component | What to Test | +|-----------|--------------| +| ViewModels | State updates, error handling, data transformations | +| Repositories | Data fetching logic, caching behavior | +| Use Cases | Business rules, calculations (efficiency, totals) | +| API Models | JSON parsing, null handling | + +**Tools:** +- JUnit 5 - Test framework +- MockK - Kotlin-friendly mocking +- Kotlinx Coroutines Test - Testing suspend functions +- Turbine - Testing Kotlin Flows + +**Example:** +```kotlin +@Test +fun `dashboard shows error state when API fails`() = runTest { + // Given + coEvery { repository.getCarStatus(any()) } throws IOException() + + // When + viewModel.loadDashboard() + + // Then + assertIs(viewModel.state.value) +} +``` + +### Integration Tests (src/androidTest/) +**What:** Test components working together with real Android framework + +| Test | Purpose | +|------|---------| +| API Client | Verify Retrofit correctly parses real API responses | +| Repository | Test data flow from API to domain models | +| DataStore | Verify settings persistence | + +**Tools:** +- MockWebServer - Fake HTTP server for API tests +- Hilt Testing - DI in tests + +### UI Tests (src/androidTest/) +**What:** Test Compose UI behavior and navigation + +**Tools:** +- Compose UI Test - Find elements, perform clicks, verify state +- Navigation Testing - Verify screen transitions + +**Example:** +```kotlin +@Test +fun settingsScreen_validUrl_enablesSaveButton() { + composeTestRule.setContent { + SettingsScreen() + } + + composeTestRule + .onNodeWithTag("urlInput") + .performTextInput("https://teslamate.example.com") + + composeTestRule + .onNodeWithTag("saveButton") + .assertIsEnabled() +} +``` + +### Running Tests + +```bash +# Run all unit tests +./gradlew test + +# Run unit tests with coverage report +./gradlew testDebugUnitTest jacocoTestReport + +# Run instrumented tests (requires emulator) +./gradlew connectedAndroidTest + +# Run specific test class +./gradlew test --tests "com.matedroid.ui.DashboardViewModelTest" +``` + +--- + +## Development Workflow + +### Prerequisites +- Android Studio installed βœ“ +- Android Emulator configured βœ“ +- Java 17 installed + +### Daily Development Cycle + +#### 1. Start the Emulator +**Option A - Android Studio:** +1. Open Android Studio +2. **Tools β†’ Device Manager** +3. Click the play button next to your emulator + +**Option B - Command Line:** +```bash +# List available emulators +emulator -list-avds + +# Start emulator (replace with your AVD name) +emulator -avd Pixel_7_API_34 & +``` + +#### 2. Build and Run the App + +**Option A - Android Studio (Recommended for beginners):** +1. Open the `matedroid` folder in Android Studio +2. Wait for Gradle sync (bottom progress bar) +3. Click the green **Run β–Ά** button (top toolbar) +4. Select your emulator from the dropdown +5. App launches automatically + +**Option B - Terminal:** +```bash +# Build and install debug APK +./gradlew installDebug + +# Launch the app +adb shell am start -n com.matedroid/.MainActivity +``` + +#### 3. See Changes + +**Hot Reload (Compose Preview):** +- In Android Studio, Compose `@Preview` functions render live +- Changes to UI code update instantly in the preview pane +- No need to rebuild for visual tweaks + +**Apply Changes (Running App):** +- Android Studio: Click **Apply Changes** (⚑ button) for code changes +- Or **Apply Code Changes** (⚑⚑) for structural changes +- Full rebuild only needed for manifest/resource changes + +**Manual Rebuild:** +```bash +# Rebuild and reinstall +./gradlew installDebug +``` + +#### 4. View Logs + +**Android Studio:** +- **View β†’ Tool Windows β†’ Logcat** +- Filter by app: Select `com.matedroid` from dropdown + +**Terminal:** +```bash +# All logs from the app +adb logcat | grep -i matedroid + +# Or with pidcat (cleaner output, install separately) +pidcat com.matedroid +``` + +### Android Studio Tips for Beginners + +| Task | How | +|------|-----| +| Open project | File β†’ Open β†’ Select `matedroid` folder | +| Run app | Green β–Ά button or `Shift+F10` | +| Stop app | Red β–  button or `Ctrl+F2` | +| View logs | View β†’ Tool Windows β†’ Logcat | +| Compose preview | Open a file with `@Preview`, see right panel | +| Rebuild project | Build β†’ Rebuild Project | +| Sync Gradle | Click "Sync Now" when prompted, or File β†’ Sync Project | +| Find files | Double-tap `Shift`, then type filename | +| Find in files | `Ctrl+Shift+F` | + +### Inspecting the Emulator + +The emulator behaves like a real phone: +- **Swipe** to navigate +- **Click** to tap +- **Extended Controls** (... button): Simulate location, battery, network conditions +- **Screenshot**: Click camera icon in emulator toolbar +- **Screen Recording**: Click video icon for recordings + +### Debugging + +1. Set breakpoints: Click in the gutter (left of line numbers) +2. Run in debug mode: Click **Debug** (bug icon) instead of Run +3. Inspect variables when breakpoint hits +4. Step through code with F8 (step over) / F7 (step into) + +--- + +## Future Considerations (Out of Scope for v1) + +- iOS version with Kotlin Multiplatform +- Wear OS companion app +- Android Auto integration +- Geofencing (notifications when arriving/leaving locations) +- Integration with home automation (MQTT) +- Cost tracking with electricity rates +- Comparison with other vehicles + +--- + +## Resources + +- [TeslamateApi Documentation](https://github.com/tobiasehlert/teslamateapi) +- [Jetpack Compose Documentation](https://developer.android.com/jetpack/compose) +- [Material Design 3](https://m3.material.io/) +- [Vico Charts](https://patrykandpatrick.com/vico/) +- [Android Developers Guide](https://developer.android.com/guide) + +--- + +## Getting Started (Next Steps) + +1. Install Java 17 and Android SDK command-line tools +2. Initialize the project structure +3. Configure Gradle build files +4. Implement the Settings screen for API configuration +5. Create the API client and test connection +6. Build the Dashboard screen + +Ready to proceed with implementation when you are! diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b4f0d4 --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +# MateDroid + +A native Android application for viewing Tesla vehicle data from your self-hosted [Teslamate](https://github.com/adriankumpf/teslamate) instance via the [TeslamateApi](https://github.com/tobiasehlert/teslamateapi). + +## Features + +- **Dashboard** - Real-time vehicle status at a glance +- **Charging History** - View all charging sessions with statistics and charts +- **Drive History** - Track trips with efficiency metrics +- **Battery Health** - Monitor battery degradation over time +- **Software Updates** - Track update history + +## Requirements + +- Android 8.0 (API 26) or higher +- A running [Teslamate](https://github.com/adriankumpf/teslamate) instance +- [TeslamateApi](https://github.com/tobiasehlert/teslamateapi) deployed and accessible + +## Installation + +### From Release (Recommended) + +Download the latest APK from the [Releases](https://github.com/yourusername/matedroid/releases) page and install it on your Android device. + +### Build from Source + +#### Prerequisites + +- Java 17 or higher +- Android SDK (API 35) +- (Optional) Android Studio + +#### Build Steps + +```bash +# Clone the repository +git clone https://github.com/yourusername/matedroid.git +cd matedroid + +# Build debug APK +./gradlew assembleDebug + +# The APK will be at: app/build/outputs/apk/debug/app-debug.apk + +# Or install directly to a connected device/emulator +./gradlew installDebug +``` + +## Development + +### Project Structure + +``` +matedroid/ +β”œβ”€β”€ app/src/main/java/com/matedroid/ +β”‚ β”œβ”€β”€ data/ # Data layer (API, repository, local storage) +β”‚ β”œβ”€β”€ domain/ # Domain layer (models, use cases) +β”‚ β”œβ”€β”€ ui/ # UI layer (screens, components, theme) +β”‚ └── di/ # Dependency injection modules +β”œβ”€β”€ gradle/ # Gradle wrapper and version catalog +└── PLAN.md # Detailed implementation plan +``` + +### Tech Stack + +- **Language**: Kotlin +- **UI**: Jetpack Compose with Material Design 3 +- **Architecture**: MVVM + Clean Architecture +- **DI**: Hilt +- **Networking**: Retrofit + OkHttp + Moshi +- **Local Storage**: DataStore +- **Charts**: Vico + +### Running Tests + +```bash +# Unit tests +./gradlew test + +# Instrumented tests (requires emulator/device) +./gradlew connectedAndroidTest +``` + +### Development Workflow + +1. Start your Android emulator or connect a device +2. Build and install: `./gradlew installDebug` +3. View logs: `adb logcat | grep -i matedroid` + +Or use Android Studio: +1. Open the project folder +2. Wait for Gradle sync +3. Click Run (green play button) + +## Configuration + +On first launch, you'll be prompted to configure your TeslamateApi connection: + +1. **Server URL**: Your TeslamateApi instance URL (e.g., `https://teslamate-api.example.com`) +2. **API Token**: (Optional) If your instance requires authentication + +## License + +This project is licensed under the GNU General Public License v3.0. See [LICENSE](LICENSE) for details. + +## Acknowledgments + +- [Teslamate](https://github.com/adriankumpf/teslamate) - Self-hosted Tesla data logger +- [TeslamateApi](https://github.com/tobiasehlert/teslamateapi) - RESTful API for Teslamate +- [t-buddy](https://github.com/garanda21/t-buddy) - iOS app inspiration diff --git a/app/build.gradle.kts b/app/build.gradle.kts new file mode 100644 index 0000000..efdfe21 --- /dev/null +++ b/app/build.gradle.kts @@ -0,0 +1,106 @@ +plugins { + alias(libs.plugins.android.application) + alias(libs.plugins.kotlin.android) + alias(libs.plugins.kotlin.compose) + alias(libs.plugins.hilt) + alias(libs.plugins.ksp) +} + +android { + namespace = "com.matedroid" + compileSdk = 35 + + defaultConfig { + applicationId = "com.matedroid" + minSdk = 26 + targetSdk = 35 + versionCode = 1 + versionName = "0.1.0" + + testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" + } + + buildTypes { + release { + isMinifyEnabled = true + isShrinkResources = true + proguardFiles( + getDefaultProguardFile("proguard-android-optimize.txt"), + "proguard-rules.pro" + ) + } + debug { + isMinifyEnabled = false + } + } + + compileOptions { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 + } + + kotlinOptions { + jvmTarget = "17" + } + + buildFeatures { + compose = true + buildConfig = true + } + + packaging { + resources { + excludes += "/META-INF/{AL2.0,LGPL2.1}" + } + } +} + +dependencies { + // Core Android + implementation(libs.androidx.core.ktx) + implementation(libs.androidx.lifecycle.runtime.ktx) + implementation(libs.androidx.lifecycle.viewmodel.compose) + implementation(libs.androidx.activity.compose) + + // Compose + implementation(platform(libs.androidx.compose.bom)) + implementation(libs.androidx.compose.ui) + implementation(libs.androidx.compose.ui.graphics) + implementation(libs.androidx.compose.ui.tooling.preview) + implementation(libs.androidx.compose.material3) + implementation(libs.androidx.compose.material.icons.extended) + implementation(libs.androidx.navigation.compose) + + // Hilt + implementation(libs.hilt.android) + ksp(libs.hilt.compiler) + implementation(libs.hilt.navigation.compose) + + // Networking + implementation(libs.retrofit) + implementation(libs.retrofit.converter.moshi) + implementation(libs.okhttp) + implementation(libs.okhttp.logging) + implementation(libs.moshi) + implementation(libs.moshi.kotlin) + ksp(libs.moshi.codegen) + + // DataStore + implementation(libs.datastore.preferences) + implementation(libs.security.crypto) + + // Charts + implementation(libs.vico.compose.m3) + + // Testing + testImplementation(libs.junit) + testImplementation(libs.coroutines.test) + testImplementation(libs.mockk) + testImplementation(libs.turbine) + androidTestImplementation(libs.androidx.junit) + androidTestImplementation(libs.androidx.espresso.core) + androidTestImplementation(platform(libs.androidx.compose.bom)) + androidTestImplementation(libs.androidx.compose.ui.test.junit4) + debugImplementation(libs.androidx.compose.ui.tooling) + debugImplementation(libs.androidx.compose.ui.test.manifest) +} diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro new file mode 100644 index 0000000..08a207e --- /dev/null +++ b/app/proguard-rules.pro @@ -0,0 +1,31 @@ +# Add project specific ProGuard rules here. +# By default, the flags in this file are appended to flags specified +# in the Android SDK tools. + +# Retrofit +-keepattributes Signature +-keepattributes *Annotation* +-keep class retrofit2.** { *; } +-keepclasseswithmembers class * { + @retrofit2.http.* ; +} + +# Moshi +-keep class com.squareup.moshi.** { *; } +-keep @com.squareup.moshi.JsonQualifier interface * +-keepclassmembers @com.squareup.moshi.JsonClass class * extends java.lang.Enum { + ; +} +-keepclassmembers class * { + @com.squareup.moshi.FromJson ; + @com.squareup.moshi.ToJson ; +} + +# Keep data models +-keep class com.matedroid.data.api.models.** { *; } +-keep class com.matedroid.domain.model.** { *; } + +# OkHttp +-dontwarn okhttp3.** +-dontwarn okio.** +-keep class okhttp3.** { *; } diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..0b11e68 --- /dev/null +++ b/app/src/main/AndroidManifest.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + diff --git a/app/src/main/java/com/matedroid/MainActivity.kt b/app/src/main/java/com/matedroid/MainActivity.kt new file mode 100644 index 0000000..c419a41 --- /dev/null +++ b/app/src/main/java/com/matedroid/MainActivity.kt @@ -0,0 +1,31 @@ +package com.matedroid + +import android.os.Bundle +import androidx.activity.ComponentActivity +import androidx.activity.compose.setContent +import androidx.activity.enableEdgeToEdge +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.Surface +import androidx.compose.ui.Modifier +import com.matedroid.ui.navigation.NavGraph +import com.matedroid.ui.theme.MateDroidTheme +import dagger.hilt.android.AndroidEntryPoint + +@AndroidEntryPoint +class MainActivity : ComponentActivity() { + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + enableEdgeToEdge() + setContent { + MateDroidTheme { + Surface( + modifier = Modifier.fillMaxSize(), + color = MaterialTheme.colorScheme.background + ) { + NavGraph() + } + } + } + } +} diff --git a/app/src/main/java/com/matedroid/MateDroidApp.kt b/app/src/main/java/com/matedroid/MateDroidApp.kt new file mode 100644 index 0000000..1e13d62 --- /dev/null +++ b/app/src/main/java/com/matedroid/MateDroidApp.kt @@ -0,0 +1,7 @@ +package com.matedroid + +import android.app.Application +import dagger.hilt.android.HiltAndroidApp + +@HiltAndroidApp +class MateDroidApp : Application() diff --git a/app/src/main/java/com/matedroid/data/local/SettingsDataStore.kt b/app/src/main/java/com/matedroid/data/local/SettingsDataStore.kt new file mode 100644 index 0000000..7aad3ea --- /dev/null +++ b/app/src/main/java/com/matedroid/data/local/SettingsDataStore.kt @@ -0,0 +1,51 @@ +package com.matedroid.data.local + +import android.content.Context +import androidx.datastore.core.DataStore +import androidx.datastore.preferences.core.Preferences +import androidx.datastore.preferences.core.edit +import androidx.datastore.preferences.core.stringPreferencesKey +import androidx.datastore.preferences.preferencesDataStore +import dagger.hilt.android.qualifiers.ApplicationContext +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.map +import javax.inject.Inject +import javax.inject.Singleton + +private val Context.dataStore: DataStore by preferencesDataStore(name = "matedroid_settings") + +data class AppSettings( + val serverUrl: String = "", + val apiToken: String = "" +) { + val isConfigured: Boolean + get() = serverUrl.isNotBlank() +} + +@Singleton +class SettingsDataStore @Inject constructor( + @ApplicationContext private val context: Context +) { + private val serverUrlKey = stringPreferencesKey("server_url") + private val apiTokenKey = stringPreferencesKey("api_token") + + val settings: Flow = context.dataStore.data.map { preferences -> + AppSettings( + serverUrl = preferences[serverUrlKey] ?: "", + apiToken = preferences[apiTokenKey] ?: "" + ) + } + + suspend fun saveSettings(serverUrl: String, apiToken: String) { + context.dataStore.edit { preferences -> + preferences[serverUrlKey] = serverUrl + preferences[apiTokenKey] = apiToken + } + } + + suspend fun clearSettings() { + context.dataStore.edit { preferences -> + preferences.clear() + } + } +} diff --git a/app/src/main/java/com/matedroid/di/AppModule.kt b/app/src/main/java/com/matedroid/di/AppModule.kt new file mode 100644 index 0000000..947d820 --- /dev/null +++ b/app/src/main/java/com/matedroid/di/AppModule.kt @@ -0,0 +1,23 @@ +package com.matedroid.di + +import android.content.Context +import com.matedroid.data.local.SettingsDataStore +import dagger.Module +import dagger.Provides +import dagger.hilt.InstallIn +import dagger.hilt.android.qualifiers.ApplicationContext +import dagger.hilt.components.SingletonComponent +import javax.inject.Singleton + +@Module +@InstallIn(SingletonComponent::class) +object AppModule { + + @Provides + @Singleton + fun provideSettingsDataStore( + @ApplicationContext context: Context + ): SettingsDataStore { + return SettingsDataStore(context) + } +} diff --git a/app/src/main/java/com/matedroid/ui/navigation/NavGraph.kt b/app/src/main/java/com/matedroid/ui/navigation/NavGraph.kt new file mode 100644 index 0000000..ba5f798 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/navigation/NavGraph.kt @@ -0,0 +1,44 @@ +package com.matedroid.ui.navigation + +import androidx.compose.runtime.Composable +import androidx.navigation.compose.NavHost +import androidx.navigation.compose.composable +import androidx.navigation.compose.rememberNavController +import com.matedroid.ui.screens.settings.SettingsScreen + +sealed class Screen(val route: String) { + data object Settings : Screen("settings") + data object Dashboard : Screen("dashboard") + data object Charges : Screen("charges") + data object ChargeDetail : Screen("charges/{chargeId}") { + fun createRoute(chargeId: Int) = "charges/$chargeId" + } + data object Drives : Screen("drives") + data object DriveDetail : Screen("drives/{driveId}") { + fun createRoute(driveId: Int) = "drives/$driveId" + } + data object Battery : Screen("battery") + data object Updates : Screen("updates") +} + +@Composable +fun NavGraph() { + val navController = rememberNavController() + + NavHost( + navController = navController, + startDestination = Screen.Settings.route + ) { + composable(Screen.Settings.route) { + SettingsScreen( + onNavigateToDashboard = { + navController.navigate(Screen.Dashboard.route) { + popUpTo(Screen.Settings.route) { inclusive = true } + } + } + ) + } + + // Dashboard and other screens will be added in subsequent phases + } +} diff --git a/app/src/main/java/com/matedroid/ui/screens/settings/SettingsScreen.kt b/app/src/main/java/com/matedroid/ui/screens/settings/SettingsScreen.kt new file mode 100644 index 0000000..f73ab86 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/screens/settings/SettingsScreen.kt @@ -0,0 +1,318 @@ +package com.matedroid.ui.screens.settings + +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.Row +import androidx.compose.foundation.layout.Spacer +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.fillMaxWidth +import androidx.compose.foundation.layout.height +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.layout.size +import androidx.compose.foundation.layout.width +import androidx.compose.foundation.rememberScrollState +import androidx.compose.foundation.text.KeyboardOptions +import androidx.compose.foundation.verticalScroll +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.filled.CheckCircle +import androidx.compose.material.icons.filled.Error +import androidx.compose.material.icons.filled.Visibility +import androidx.compose.material.icons.filled.VisibilityOff +import androidx.compose.material3.Button +import androidx.compose.material3.Card +import androidx.compose.material3.CardDefaults +import androidx.compose.material3.CircularProgressIndicator +import androidx.compose.material3.ExperimentalMaterial3Api +import androidx.compose.material3.Icon +import androidx.compose.material3.IconButton +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.OutlinedButton +import androidx.compose.material3.OutlinedTextField +import androidx.compose.material3.Scaffold +import androidx.compose.material3.SnackbarHost +import androidx.compose.material3.SnackbarHostState +import androidx.compose.material3.Text +import androidx.compose.material3.TopAppBar +import androidx.compose.runtime.Composable +import androidx.compose.runtime.LaunchedEffect +import androidx.compose.runtime.collectAsState +import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.runtime.setValue +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.platform.testTag +import androidx.compose.ui.text.input.KeyboardType +import androidx.compose.ui.text.input.PasswordVisualTransformation +import androidx.compose.ui.text.input.VisualTransformation +import androidx.compose.ui.tooling.preview.Preview +import androidx.compose.ui.unit.dp +import androidx.hilt.navigation.compose.hiltViewModel +import com.matedroid.ui.theme.MateDroidTheme +import com.matedroid.ui.theme.StatusError +import com.matedroid.ui.theme.StatusSuccess + +@OptIn(ExperimentalMaterial3Api::class) +@Composable +fun SettingsScreen( + onNavigateToDashboard: () -> Unit, + viewModel: SettingsViewModel = hiltViewModel() +) { + val uiState by viewModel.uiState.collectAsState() + val snackbarHostState = remember { SnackbarHostState() } + + LaunchedEffect(uiState.error) { + uiState.error?.let { + snackbarHostState.showSnackbar(it) + viewModel.clearError() + } + } + + Scaffold( + topBar = { + TopAppBar( + title = { Text("MateDroid Settings") } + ) + }, + snackbarHost = { SnackbarHost(snackbarHostState) } + ) { paddingValues -> + if (uiState.isLoading) { + LoadingContent(modifier = Modifier.padding(paddingValues)) + } else { + SettingsContent( + modifier = Modifier.padding(paddingValues), + uiState = uiState, + onServerUrlChange = viewModel::updateServerUrl, + onApiTokenChange = viewModel::updateApiToken, + onTestConnection = viewModel::testConnection, + onSave = { viewModel.saveSettings(onNavigateToDashboard) } + ) + } + } +} + +@Composable +private fun LoadingContent(modifier: Modifier = Modifier) { + Column( + modifier = modifier.fillMaxSize(), + horizontalAlignment = Alignment.CenterHorizontally, + verticalArrangement = Arrangement.Center + ) { + CircularProgressIndicator() + Spacer(modifier = Modifier.height(16.dp)) + Text("Loading settings...") + } +} + +@Composable +private fun SettingsContent( + modifier: Modifier = Modifier, + uiState: SettingsUiState, + onServerUrlChange: (String) -> Unit, + onApiTokenChange: (String) -> Unit, + onTestConnection: () -> Unit, + onSave: () -> Unit +) { + var passwordVisible by remember { mutableStateOf(false) } + + Column( + modifier = modifier + .fillMaxSize() + .verticalScroll(rememberScrollState()) + .padding(16.dp) + ) { + Text( + text = "Connect to TeslamateApi", + style = MaterialTheme.typography.headlineSmall + ) + + Spacer(modifier = Modifier.height(8.dp)) + + Text( + text = "Enter your TeslamateApi server URL and optional API token to connect.", + style = MaterialTheme.typography.bodyMedium, + color = MaterialTheme.colorScheme.onSurfaceVariant + ) + + Spacer(modifier = Modifier.height(24.dp)) + + OutlinedTextField( + value = uiState.serverUrl, + onValueChange = onServerUrlChange, + label = { Text("Server URL") }, + placeholder = { Text("https://teslamate.example.com") }, + modifier = Modifier + .fillMaxWidth() + .testTag("urlInput"), + singleLine = true, + keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Uri), + enabled = !uiState.isTesting && !uiState.isSaving + ) + + Spacer(modifier = Modifier.height(16.dp)) + + OutlinedTextField( + value = uiState.apiToken, + onValueChange = onApiTokenChange, + label = { Text("API Token (optional)") }, + placeholder = { Text("Your API token") }, + modifier = Modifier + .fillMaxWidth() + .testTag("tokenInput"), + singleLine = true, + visualTransformation = if (passwordVisible) { + VisualTransformation.None + } else { + PasswordVisualTransformation() + }, + keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password), + trailingIcon = { + IconButton(onClick = { passwordVisible = !passwordVisible }) { + Icon( + imageVector = if (passwordVisible) { + Icons.Filled.VisibilityOff + } else { + Icons.Filled.Visibility + }, + contentDescription = if (passwordVisible) { + "Hide token" + } else { + "Show token" + } + ) + } + }, + enabled = !uiState.isTesting && !uiState.isSaving + ) + + Spacer(modifier = Modifier.height(8.dp)) + + Text( + text = "Leave empty if your TeslamateApi doesn't require authentication.", + style = MaterialTheme.typography.bodySmall, + color = MaterialTheme.colorScheme.onSurfaceVariant + ) + + Spacer(modifier = Modifier.height(24.dp)) + + // Test result card + uiState.testResult?.let { result -> + TestResultCard(result = result) + Spacer(modifier = Modifier.height(16.dp)) + } + + // Action buttons + Row( + modifier = Modifier.fillMaxWidth(), + horizontalArrangement = Arrangement.spacedBy(12.dp) + ) { + OutlinedButton( + onClick = onTestConnection, + enabled = uiState.serverUrl.isNotBlank() && !uiState.isTesting && !uiState.isSaving, + modifier = Modifier.weight(1f) + ) { + if (uiState.isTesting) { + CircularProgressIndicator( + modifier = Modifier.size(18.dp), + strokeWidth = 2.dp + ) + Spacer(modifier = Modifier.width(8.dp)) + } + Text("Test Connection") + } + + Button( + onClick = onSave, + enabled = uiState.serverUrl.isNotBlank() && !uiState.isTesting && !uiState.isSaving, + modifier = Modifier + .weight(1f) + .testTag("saveButton") + ) { + if (uiState.isSaving) { + CircularProgressIndicator( + modifier = Modifier.size(18.dp), + strokeWidth = 2.dp, + color = MaterialTheme.colorScheme.onPrimary + ) + Spacer(modifier = Modifier.width(8.dp)) + } + Text("Save & Continue") + } + } + } +} + +@Composable +private fun TestResultCard(result: TestResult) { + val (icon, color, text) = when (result) { + is TestResult.Success -> Triple( + Icons.Filled.CheckCircle, + StatusSuccess, + "Connection successful!" + ) + is TestResult.Failure -> Triple( + Icons.Filled.Error, + StatusError, + "Connection failed: ${result.message}" + ) + } + + Card( + modifier = Modifier.fillMaxWidth(), + colors = CardDefaults.cardColors( + containerColor = color.copy(alpha = 0.1f) + ) + ) { + Row( + modifier = Modifier + .fillMaxWidth() + .padding(16.dp), + verticalAlignment = Alignment.CenterVertically + ) { + Icon( + imageVector = icon, + contentDescription = null, + tint = color + ) + Spacer(modifier = Modifier.width(12.dp)) + Text( + text = text, + color = color, + style = MaterialTheme.typography.bodyMedium + ) + } + } +} + +@Preview(showBackground = true) +@Composable +private fun SettingsScreenPreview() { + MateDroidTheme { + SettingsContent( + uiState = SettingsUiState(isLoading = false), + onServerUrlChange = {}, + onApiTokenChange = {}, + onTestConnection = {}, + onSave = {} + ) + } +} + +@Preview(showBackground = true) +@Composable +private fun SettingsScreenWithResultPreview() { + MateDroidTheme { + SettingsContent( + uiState = SettingsUiState( + isLoading = false, + serverUrl = "https://teslamate.example.com", + testResult = TestResult.Success + ), + onServerUrlChange = {}, + onApiTokenChange = {}, + onTestConnection = {}, + onSave = {} + ) + } +} diff --git a/app/src/main/java/com/matedroid/ui/screens/settings/SettingsViewModel.kt b/app/src/main/java/com/matedroid/ui/screens/settings/SettingsViewModel.kt new file mode 100644 index 0000000..f693066 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/screens/settings/SettingsViewModel.kt @@ -0,0 +1,144 @@ +package com.matedroid.ui.screens.settings + +import androidx.lifecycle.ViewModel +import androidx.lifecycle.viewModelScope +import com.matedroid.data.local.AppSettings +import com.matedroid.data.local.SettingsDataStore +import dagger.hilt.android.lifecycle.HiltViewModel +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.flow.StateFlow +import kotlinx.coroutines.flow.asStateFlow +import kotlinx.coroutines.flow.first +import kotlinx.coroutines.launch +import javax.inject.Inject + +data class SettingsUiState( + val serverUrl: String = "", + val apiToken: String = "", + val isLoading: Boolean = true, + val isTesting: Boolean = false, + val isSaving: Boolean = false, + val testResult: TestResult? = null, + val error: String? = null +) + +sealed class TestResult { + data object Success : TestResult() + data class Failure(val message: String) : TestResult() +} + +@HiltViewModel +class SettingsViewModel @Inject constructor( + private val settingsDataStore: SettingsDataStore +) : ViewModel() { + + private val _uiState = MutableStateFlow(SettingsUiState()) + val uiState: StateFlow = _uiState.asStateFlow() + + init { + loadSettings() + } + + private fun loadSettings() { + viewModelScope.launch { + val settings = settingsDataStore.settings.first() + _uiState.value = _uiState.value.copy( + serverUrl = settings.serverUrl, + apiToken = settings.apiToken, + isLoading = false + ) + } + } + + fun updateServerUrl(url: String) { + _uiState.value = _uiState.value.copy( + serverUrl = url, + testResult = null, + error = null + ) + } + + fun updateApiToken(token: String) { + _uiState.value = _uiState.value.copy( + apiToken = token, + testResult = null, + error = null + ) + } + + fun testConnection() { + viewModelScope.launch { + _uiState.value = _uiState.value.copy(isTesting = true, testResult = null, error = null) + + try { + val url = _uiState.value.serverUrl.trimEnd('/') + if (url.isBlank()) { + _uiState.value = _uiState.value.copy( + isTesting = false, + testResult = TestResult.Failure("Server URL is required") + ) + return@launch + } + + // TODO: Implement actual API ping test in Phase 2 + // For now, just validate URL format + if (!url.startsWith("http://") && !url.startsWith("https://")) { + _uiState.value = _uiState.value.copy( + isTesting = false, + testResult = TestResult.Failure("URL must start with http:// or https://") + ) + return@launch + } + + // Simulate successful test for now + _uiState.value = _uiState.value.copy( + isTesting = false, + testResult = TestResult.Success + ) + } catch (e: Exception) { + _uiState.value = _uiState.value.copy( + isTesting = false, + testResult = TestResult.Failure(e.message ?: "Unknown error") + ) + } + } + } + + fun saveSettings(onSuccess: () -> Unit) { + viewModelScope.launch { + _uiState.value = _uiState.value.copy(isSaving = true, error = null) + + try { + val url = _uiState.value.serverUrl.trimEnd('/') + if (url.isBlank()) { + _uiState.value = _uiState.value.copy( + isSaving = false, + error = "Server URL is required" + ) + return@launch + } + + settingsDataStore.saveSettings( + serverUrl = url, + apiToken = _uiState.value.apiToken + ) + + _uiState.value = _uiState.value.copy(isSaving = false) + onSuccess() + } catch (e: Exception) { + _uiState.value = _uiState.value.copy( + isSaving = false, + error = e.message ?: "Failed to save settings" + ) + } + } + } + + fun clearTestResult() { + _uiState.value = _uiState.value.copy(testResult = null) + } + + fun clearError() { + _uiState.value = _uiState.value.copy(error = null) + } +} diff --git a/app/src/main/java/com/matedroid/ui/theme/Color.kt b/app/src/main/java/com/matedroid/ui/theme/Color.kt new file mode 100644 index 0000000..5662b86 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/theme/Color.kt @@ -0,0 +1,53 @@ +package com.matedroid.ui.theme + +import androidx.compose.ui.graphics.Color + +// Tesla-inspired colors +val TeslaRed = Color(0xFFE31937) +val TeslaDark = Color(0xFF171A20) +val TeslaBlue = Color(0xFF3E6AE1) + +// Status colors +val StatusSuccess = Color(0xFF4CAF50) +val StatusWarning = Color(0xFFFF9800) +val StatusError = Color(0xFFF44336) + +// Light theme colors +val PrimaryLight = TeslaRed +val OnPrimaryLight = Color.White +val PrimaryContainerLight = Color(0xFFFFDAD6) +val OnPrimaryContainerLight = Color(0xFF410002) +val SecondaryLight = TeslaDark +val OnSecondaryLight = Color.White +val SecondaryContainerLight = Color(0xFFE2E2E2) +val OnSecondaryContainerLight = Color(0xFF1B1B1B) +val TertiaryLight = TeslaBlue +val OnTertiaryLight = Color.White +val BackgroundLight = Color(0xFFFFFBFF) +val OnBackgroundLight = Color(0xFF1C1B1F) +val SurfaceLight = Color(0xFFFFFBFF) +val OnSurfaceLight = Color(0xFF1C1B1F) +val SurfaceVariantLight = Color(0xFFF5DDDA) +val OnSurfaceVariantLight = Color(0xFF534341) +val ErrorLight = StatusError +val OnErrorLight = Color.White + +// Dark theme colors +val PrimaryDark = Color(0xFFFFB4AB) +val OnPrimaryDark = Color(0xFF690005) +val PrimaryContainerDark = TeslaRed +val OnPrimaryContainerDark = Color.White +val SecondaryDark = Color(0xFFC6C6C6) +val OnSecondaryDark = Color(0xFF303030) +val SecondaryContainerDark = Color(0xFF474747) +val OnSecondaryContainerDark = Color(0xFFE2E2E2) +val TertiaryDark = Color(0xFFADC6FF) +val OnTertiaryDark = Color(0xFF002E69) +val BackgroundDark = Color(0xFF1C1B1F) +val OnBackgroundDark = Color(0xFFE6E1E5) +val SurfaceDark = Color(0xFF1C1B1F) +val OnSurfaceDark = Color(0xFFE6E1E5) +val SurfaceVariantDark = Color(0xFF534341) +val OnSurfaceVariantDark = Color(0xFFD8C2BF) +val ErrorDark = Color(0xFFFFB4AB) +val OnErrorDark = Color(0xFF690005) diff --git a/app/src/main/java/com/matedroid/ui/theme/Theme.kt b/app/src/main/java/com/matedroid/ui/theme/Theme.kt new file mode 100644 index 0000000..27e15d5 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/theme/Theme.kt @@ -0,0 +1,75 @@ +package com.matedroid.ui.theme + +import android.os.Build +import androidx.compose.foundation.isSystemInDarkTheme +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.darkColorScheme +import androidx.compose.material3.dynamicDarkColorScheme +import androidx.compose.material3.dynamicLightColorScheme +import androidx.compose.material3.lightColorScheme +import androidx.compose.runtime.Composable +import androidx.compose.ui.platform.LocalContext + +private val DarkColorScheme = darkColorScheme( + primary = PrimaryDark, + onPrimary = OnPrimaryDark, + primaryContainer = PrimaryContainerDark, + onPrimaryContainer = OnPrimaryContainerDark, + secondary = SecondaryDark, + onSecondary = OnSecondaryDark, + secondaryContainer = SecondaryContainerDark, + onSecondaryContainer = OnSecondaryContainerDark, + tertiary = TertiaryDark, + onTertiary = OnTertiaryDark, + background = BackgroundDark, + onBackground = OnBackgroundDark, + surface = SurfaceDark, + onSurface = OnSurfaceDark, + surfaceVariant = SurfaceVariantDark, + onSurfaceVariant = OnSurfaceVariantDark, + error = ErrorDark, + onError = OnErrorDark +) + +private val LightColorScheme = lightColorScheme( + primary = PrimaryLight, + onPrimary = OnPrimaryLight, + primaryContainer = PrimaryContainerLight, + onPrimaryContainer = OnPrimaryContainerLight, + secondary = SecondaryLight, + onSecondary = OnSecondaryLight, + secondaryContainer = SecondaryContainerLight, + onSecondaryContainer = OnSecondaryContainerLight, + tertiary = TertiaryLight, + onTertiary = OnTertiaryLight, + background = BackgroundLight, + onBackground = OnBackgroundLight, + surface = SurfaceLight, + onSurface = OnSurfaceLight, + surfaceVariant = SurfaceVariantLight, + onSurfaceVariant = OnSurfaceVariantLight, + error = ErrorLight, + onError = OnErrorLight +) + +@Composable +fun MateDroidTheme( + darkTheme: Boolean = isSystemInDarkTheme(), + dynamicColor: Boolean = true, + content: @Composable () -> Unit +) { + val colorScheme = when { + dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { + val context = LocalContext.current + if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) + } + darkTheme -> DarkColorScheme + else -> LightColorScheme + } + + MaterialTheme( + colorScheme = colorScheme, + typography = Typography, + content = content + ) +} diff --git a/app/src/main/java/com/matedroid/ui/theme/Type.kt b/app/src/main/java/com/matedroid/ui/theme/Type.kt new file mode 100644 index 0000000..adbce14 --- /dev/null +++ b/app/src/main/java/com/matedroid/ui/theme/Type.kt @@ -0,0 +1,115 @@ +package com.matedroid.ui.theme + +import androidx.compose.material3.Typography +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.font.FontFamily +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.sp + +val Typography = Typography( + displayLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 57.sp, + lineHeight = 64.sp, + letterSpacing = (-0.25).sp + ), + displayMedium = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 45.sp, + lineHeight = 52.sp, + letterSpacing = 0.sp + ), + displaySmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 36.sp, + lineHeight = 44.sp, + letterSpacing = 0.sp + ), + headlineLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 32.sp, + lineHeight = 40.sp, + letterSpacing = 0.sp + ), + headlineMedium = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 28.sp, + lineHeight = 36.sp, + letterSpacing = 0.sp + ), + headlineSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 24.sp, + lineHeight = 32.sp, + letterSpacing = 0.sp + ), + titleLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 22.sp, + lineHeight = 28.sp, + letterSpacing = 0.sp + ), + titleMedium = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 16.sp, + lineHeight = 24.sp, + letterSpacing = 0.15.sp + ), + titleSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 14.sp, + lineHeight = 20.sp, + letterSpacing = 0.1.sp + ), + bodyLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 16.sp, + lineHeight = 24.sp, + letterSpacing = 0.5.sp + ), + bodyMedium = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 14.sp, + lineHeight = 20.sp, + letterSpacing = 0.25.sp + ), + bodySmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 12.sp, + lineHeight = 16.sp, + letterSpacing = 0.4.sp + ), + labelLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 14.sp, + lineHeight = 20.sp, + letterSpacing = 0.1.sp + ), + labelMedium = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 12.sp, + lineHeight = 16.sp, + letterSpacing = 0.5.sp + ), + labelSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 11.sp, + lineHeight = 16.sp, + letterSpacing = 0.5.sp + ) +) diff --git a/app/src/main/res/drawable/ic_launcher_background.xml b/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000..f786c65 --- /dev/null +++ b/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,10 @@ + + + + diff --git a/app/src/main/res/drawable/ic_launcher_foreground.xml b/app/src/main/res/drawable/ic_launcher_foreground.xml new file mode 100644 index 0000000..b5f0679 --- /dev/null +++ b/app/src/main/res/drawable/ic_launcher_foreground.xml @@ -0,0 +1,11 @@ + + + + + diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000..d378acd --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000..d378acd --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/app/src/main/res/values/colors.xml b/app/src/main/res/values/colors.xml new file mode 100644 index 0000000..8bbf421 --- /dev/null +++ b/app/src/main/res/values/colors.xml @@ -0,0 +1,12 @@ + + + + #E31937 + #171A20 + #3E6AE1 + + + #4CAF50 + #FF9800 + #F44336 + diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..a8f99b8 --- /dev/null +++ b/app/src/main/res/values/strings.xml @@ -0,0 +1,4 @@ + + + MateDroid + diff --git a/app/src/main/res/values/themes.xml b/app/src/main/res/values/themes.xml new file mode 100644 index 0000000..f47e403 --- /dev/null +++ b/app/src/main/res/values/themes.xml @@ -0,0 +1,7 @@ + + + + diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..73af60d --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,7 @@ +plugins { + alias(libs.plugins.android.application) apply false + alias(libs.plugins.kotlin.android) apply false + alias(libs.plugins.kotlin.compose) apply false + alias(libs.plugins.hilt) apply false + alias(libs.plugins.ksp) apply false +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..3e72f62 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,22 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. + +# Specifies the JVM arguments used for the daemon process. +org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 + +# When configured, Gradle will run in incubating parallel mode. +org.gradle.parallel=true + +# Enable configuration caching for faster builds +org.gradle.configuration-cache=true + +# AndroidX package structure +android.useAndroidX=true + +# Kotlin code style +kotlin.code.style=official + +# Enables namespacing of each library's R class +android.nonTransitiveRClass=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..275d214 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,78 @@ +[versions] +agp = "8.7.2" +kotlin = "2.0.21" +ksp = "2.0.21-1.0.27" +coreKtx = "1.15.0" +lifecycleRuntimeKtx = "2.8.7" +activityCompose = "1.9.3" +composeBom = "2024.11.00" +navigationCompose = "2.8.4" +hilt = "2.53.1" +hiltNavigationCompose = "1.2.0" +retrofit = "2.11.0" +okhttp = "4.12.0" +moshi = "1.15.1" +datastore = "1.1.1" +securityCrypto = "1.1.0-alpha06" +vico = "2.0.0-beta.2" +junit = "4.13.2" +junitExt = "1.2.1" +espresso = "3.6.1" +coroutinesTest = "1.9.0" +mockk = "1.13.13" +turbine = "1.2.0" + +[libraries] +# Core Android +androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" } +androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" } +androidx-lifecycle-viewmodel-compose = { group = "androidx.lifecycle", name = "lifecycle-viewmodel-compose", version.ref = "lifecycleRuntimeKtx" } +androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" } + +# Compose +androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" } +androidx-compose-ui = { group = "androidx.compose.ui", name = "ui" } +androidx-compose-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" } +androidx-compose-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" } +androidx-compose-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" } +androidx-compose-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" } +androidx-compose-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" } +androidx-compose-material3 = { group = "androidx.compose.material3", name = "material3" } +androidx-compose-material-icons-extended = { group = "androidx.compose.material", name = "material-icons-extended" } +androidx-navigation-compose = { group = "androidx.navigation", name = "navigation-compose", version.ref = "navigationCompose" } + +# Hilt +hilt-android = { group = "com.google.dagger", name = "hilt-android", version.ref = "hilt" } +hilt-compiler = { group = "com.google.dagger", name = "hilt-compiler", version.ref = "hilt" } +hilt-navigation-compose = { group = "androidx.hilt", name = "hilt-navigation-compose", version.ref = "hiltNavigationCompose" } + +# Networking +retrofit = { group = "com.squareup.retrofit2", name = "retrofit", version.ref = "retrofit" } +retrofit-converter-moshi = { group = "com.squareup.retrofit2", name = "converter-moshi", version.ref = "retrofit" } +okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp" } +okhttp-logging = { group = "com.squareup.okhttp3", name = "logging-interceptor", version.ref = "okhttp" } +moshi = { group = "com.squareup.moshi", name = "moshi", version.ref = "moshi" } +moshi-kotlin = { group = "com.squareup.moshi", name = "moshi-kotlin", version.ref = "moshi" } +moshi-codegen = { group = "com.squareup.moshi", name = "moshi-kotlin-codegen", version.ref = "moshi" } + +# DataStore +datastore-preferences = { group = "androidx.datastore", name = "datastore-preferences", version.ref = "datastore" } +security-crypto = { group = "androidx.security", name = "security-crypto", version.ref = "securityCrypto" } + +# Charts +vico-compose-m3 = { group = "com.patrykandpatrick.vico", name = "compose-m3", version.ref = "vico" } + +# Testing +junit = { group = "junit", name = "junit", version.ref = "junit" } +androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitExt" } +androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espresso" } +coroutines-test = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-test", version.ref = "coroutinesTest" } +mockk = { group = "io.mockk", name = "mockk", version.ref = "mockk" } +turbine = { group = "app.cash.turbine", name = "turbine", version.ref = "turbine" } + +[plugins] +android-application = { id = "com.android.application", version.ref = "agp" } +kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } +kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" } +hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" } +ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..2c35211 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..09523c0 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..d95bf61 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright Β© 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions Β«$varΒ», Β«${var}Β», Β«${var:-default}Β», Β«${var+SET}Β», +# Β«${var#prefix}Β», Β«${var%suffix}Β», and Β«$( cmd )Β»; +# * compound commands having a testable exit status, especially Β«caseΒ»; +# * various built-in commands including Β«commandΒ», Β«setΒ», and Β«ulimitΒ». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..640d686 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS=-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..833b03d --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,23 @@ +pluginManagement { + repositories { + google { + content { + includeGroupByRegex("com\\.android.*") + includeGroupByRegex("com\\.google.*") + includeGroupByRegex("androidx.*") + } + } + mavenCentral() + gradlePluginPortal() + } +} +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + } +} + +rootProject.name = "MateDroid" +include(":app")