OctoMeter: Empowering Smart Electricity Usage

Production-grade Kotlin Multiplatform App targeting Desktop, Android, iOS
🇬🇧 Made in the UK, For the UK.

📝 Complementary article: Releasing my First True Kotlin Multiplatform App
⭐️ If you like this app, consider to star this repository.

It works for me

This is a dashboard-type app that runs on desktop (desktop-first), Android, and iOS. It implements an adaptive layout that works on different window sizes. The app honours light and dark modes on all available platforms.

The main purposes of this app are:

• Track the Agile Octopus tariff unit rates for the coming 24 hours, with countdown and automatic refresh.
• Compile smart meter electricity usage; estimate and project electricity usage and cost.
• Browse available Octopus Energy tariffs.

This is a fully functional app that I developed and tested by myself every day to see my energy expenses reduced by more than 50%.

At the time of development, this project is an independent third-party product that accesses Octopus Energy’s public APIs, with no official affiliation with Octopus Energy Ltd. I am not an employee of Octopus Energy or any of its related businesses.

Note

This project is incubating - an experimental product sponsored by and sublicensed to RW MobiMedia UK

• It aims to reach production level, as a general release distributable on Google Play/ App Stores.
• However, it is currently not mature yet - while it should technically work for some other Octopus Energy customers, I do not have enough sample data to cover all use cases.

Octopus Energy customers: You are invited to collaborate. If this app is not working correctly for your account. Report an issue to start a conversation.

• For non-Octopus Energy customers, or non-UK residents, the demo mode will display random meter readings and default tariff rates to illustrate the app’s functionality.

Running the app

The project dependencies are maintained by Renovate. By default, the app builds on the latest Xcode and Android Studio.

All downloadables are provided under the Release Section.

• MacOS Desktop App: We provide a DMG installer.
• Windows Desktop App: We provide both EXE and MSI installers.
• Android: We provide signed APK and App Bundle.
• iOS: Join as a tester at Test Flight.
• To build and run the Desktop app yourself, execute ./gradlew run

To-do lists

Planned enhancements are logged as issues.

RestAPI and GraphQL

Octopus Energy and Kraken prefer GraphQL over REST API. Accordingly, the second phase of this project has migrated several REST APIs to GraphQL. Unfortunately, not every REST API currently has an equivalent GraphQL counterpart; therefore, this app has a mixed use of both for demonstration purposes. I am working on identifying the GraphQL implentation for the existing RestAPI calls.

Features	Implementation
Account and meters	🕸️ GraphQL
Products Search (by postcode)	🕸️ GraphQL
Tariff details	🕸️ GraphQL
Consumptions	😴 RestAPI (Pending migration)
Half-hourly tariff rates	😴 RestAPI (Needs access to tariffs not subscribed)

Version 1.4.0 is the last version it contains pure Ktor-RestAPI implementation.

Data Security and Privacy

This app can run under the demo mode without requiring any credentials.

To pull real smart meter data from your Octopus Energy account, you need to generate an API key for your account at https://octopus.energy/dashboard/new/accounts/personal-details/api-access. This app never asks for your Octopus customer account password, and you can always generate a new API key to invalidate the old keys.

This app does not have write access to any of your customer data kept at Octopus Energy's systems.

Some technical details

• /composeApp is for Kotlin code shared across the Compose Multiplatform application. It contains several subfolders:

  • commonMain is for code that’s common for all targets.
  • androidMain is the traditional Android project root.
  • desktopMain is for the desktop (JVM) app.
  • iosMain is for the Kotlin code to be exposed to the iOS app.

• /iosApp contains the iOS application. Open OctoMeter.xcworkspace to build the App.

Dependencies

• Kermit - Apache 2.0 - A Kotlin Multiplatform logging library
• KoalaPlot - MIT - A plotting library for Kotlin Multiplatform
• AndroidX Activity Compose - Apache 2.0 - Jetpack Compose integration with Activity
• AndroidX Core Splashscreen - Apache 2.0 - Core splash screen
• AndroidX Security Crypto - Apache 2.0 - Security library for Android
• Jetpack Compose UI Tooling - Apache 2.0 - UI tooling for Jetpack Compose
• AndroidX Test Core KTX - Apache 2.0 - Core KTX library for AndroidX test
• AndroidX Room - Apache 2.0 - Room Database
• AndroidX SQLite Bundled - Apache 2.0 - Bundled SQLite for AndroidX
• Robolectric - Apache 2.0 - Unit testing framework for Android
• Ktor - Apache 2.0 - Framework for building asynchronous servers and clients in connected systems
• Kotlinx DateTime - Apache 2.0 - A multiplatform Kotlin library for working with date and time
• Kotlinx Coroutines - Apache 2.0 - Libraries for Kotlin coroutines
• Kotlinx Serialization - Apache 2.0 - Kotlin multiplatform serialization library
• Material3 Window Size Class Multiplatform - Apache 2.0 - Material Design components for Jetpack Compose
• Koin - Apache 2.0 - Dependency injection framework for Kotlin
• LeakCanary - Apache 2.0 - A memory leak detection library for Android
• Multiplatform Settings - Apache 2.0 - Multiplatform settings library for Kotlin
• Jetpack Navigation Compose - Apache 2.0 - Navigation component for Jetpack Compose
• AndroidX Lifecycle - Apache 2.0 - Lifecycles-aware components
• Theme Detector - MIT - Detect system theme (light/dark mode)
• AndroidX Test Ext JUnit - Apache 2.0 - Extensions for Android testing
• AndroidX Espresso - Apache 2.0 - UI testing framework
• AndroidX UI Automator - Apache 2.0 - UI automation testing framework
• AndroidX Benchmark - Apache 2.0 - Benchmarking library
• AndroidX Profile Installer - Apache 2.0 - Install profiles for faster startup
• SLF4J - MIT - Simple facade for logging systems
• Skiko - Apache 2.0 - Kotlin Multiplatform bindings to Skia
• Apollo GraphQL - MIT - A strongly-typed, caching GraphQL client for Android and Kotlin Multiplatform

Plugins

• Android Application Plugin - Google - Plugin for building Android applications
• Android Library Plugin - Google - Plugin for building Android libraries
• KSP Plugin - Google - Kotlin Symbol Processing API
• Android Test Plugin - Google - Plugin for Android test projects
• AndroidX Room Plugin - Google - Plugin for AndroidX Room
• Jetbrains Compose Plugin - JetBrains - Plugin for Jetpack Compose
• Compose Compiler Plugin - JetBrains - Plugin for Jetpack Compose
• Kotlin Multiplatform Plugin - JetBrains - Plugin for Kotlin Multiplatform projects
• Kotlin CocoaPods Plugin - JetBrains - Plugin for integrating with CocoaPods
• Kotlin Power Assert Plugin - JetBrains - Plugin for enhanced assertions in Kotlin
• Ktlint Plugin - JLLeitschuh - Plugin for Kotlin linter
• Kover Plugin - JetBrains - Code coverage tool for Kotlin
• Serialization Plugin - JetBrains - Plugin for Kotlin serialization
• BuildConfig Plugin - gmazzo - Plugin for generating BuildConfig classes
• Baseline Profile Plugin - AndroidX - Plugin for generating baseline profiles
• Apollo GraphQL Plugin - Apollo GraphQL - Plugin for integrating Apollo GraphQL client with Android and Kotlin projects
• Detekt Plugin - Artur Bosch - A static code analysis tool for Kotlin projects

Licenses

This project is licensed under the Mozilla Public License Version 2.0 (MPL-2.0) with a non-commercial clause. See the LICENSE file for details.

Icon licenses

Every tiny piece matters. This App contains the icons contributed by:

MIT License:

• Bootstrap Icons
• Eva Icons
• Lineicons
• Fluent UI System Icons
• Fluent UI React
• Phosphor Icons
• Tabler Icons
• akar-icons

Apache 2.0 License:

• Material Design
• Material Design Icons

CC BY 4.0 License:

• Basil Icons
• Font Awesome
• Solar Icons Set
• Streamline

ISC License:

• Lucide