Skip to content

ryanw-mobile/OctoMeter

Repository files navigation

OctoMeter: Empowering Smart Electricity Usage
GitHub Repo stars Gradle Build Codacy Coverage Badge Codacy Grade Badge Renovate enabled

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.


cover image


cover image

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.

cover image


This is a fully functional app that I developed and tested myself every day, successfully reducing my personal energy expenses by more than 50%.

This project accesses Octopus Energy’s public APIs, but has no official affiliation with Octopus Energy Ltd.

Note

This is an experimental product sponsored by and sublicensed to RW MobiMedia UK. As of July 2025, OctoMeter has entered maintenance mode. The app remains functional and continues to serve my personal needs. However:

  • No further feature development is planned.
  • Dependency updates will continue via Renovate.
  • Critical fixes may be addressed if time permits, but active maintenance is not guaranteed.
  • The iOS TestFlight build will expire and be removed starting 24 August 2025.

I want to ensure my time and efforts remain fairly aligned with my professional commitments. Keeping OctoMeter in active development could unintentionally benefit organisations that have chosen not to work with me - and it’s important for me to manage my open-source involvement responsibly.



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: Test Flight distribution is scheduled to expire on 24 August 2025. Existing testers can continue using the app until expiry. No new TestFlight builds will be uploaded..
  • To build and run the Desktop app yourself, execute ./gradlew run



To-do lists

Archived To-Do List: There were planned enhancements during active development but are no longer being actively pursued. Logged issues are kept for reference. Outstanding items are now all closed.

RestAPI and GraphQL

Octopus Energy and Kraken prefer GraphQL over REST API. This project migrated most REST APIs to GraphQL, although both are still used.

Features Implementation
Account and meters 🕸️ GraphQL
Products Search (by postcode) 🕸️ GraphQL
Tariff details 🕸️ GraphQL
Consumptions 🕸️ GraphQL
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

Plugins



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:

Apache 2.0 License:

CC BY 4.0 License:

ISC License: