GarminHomeAssistant/source/HomeAssistantView.mc

//-----------------------------------------------------------------------------------
//
// Distributed under MIT Licence
//   See https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/LICENSE.
//
//-----------------------------------------------------------------------------------
//
// GarminHomeAssistant is a Garmin IQ application written in Monkey C and routinely
// tested on a Venu 2 device. The source code is provided at:
//            https://github.com/house-of-abbey/GarminHomeAssistant.
//
// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
//
//-----------------------------------------------------------------------------------

using Toybox.Application;
using Toybox.Lang;
using Toybox.Graphics;
using Toybox.System;
using Toybox.WatchUi;

//! Home Assistant menu construction.
//
class HomeAssistantView extends WatchUi.Menu2 {

    //! Class Constructor
    //
    function initialize(
        definition as Lang.Dictionary,
        options as {
            :focus as Lang.Number,
            :icon  as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol
        } or Null
    ) {
        if (options == null) {
            options = { :title => definition.get("title") as Lang.String };
        } else {
            options.put(:title, definition.get("title") as Lang.String);
        }
        WatchUi.Menu2.initialize(options);

        var items = definition.get("items") as Lang.Array<Lang.Dictionary>;
        for (var i = 0; i < items.size(); i++) {
            if (items[i] instanceof(Lang.Dictionary)) {
                var type       = items[i].get("type")       as Lang.String     or Null;
                var name       = items[i].get("name")       as Lang.String     or Null;
                var content    = items[i].get("content")    as Lang.String     or Null;
                var entity     = items[i].get("entity")     as Lang.String     or Null;
                var tap_action = items[i].get("tap_action") as Lang.Dictionary or Null;
                var service    = items[i].get("service")    as Lang.String     or Null; // Deprecated schema
                var confirm    = false                      as Lang.Boolean    or Null;
                var pin        = false                      as Lang.Boolean    or Null;
                var data       = null                       as Lang.Dictionary or Null;
                if (tap_action != null) {
                    service = tap_action.get("service");
                    confirm = tap_action.get("confirm"); // Optional
                    pin     = tap_action.get("pin");     // Optional
                    data    = tap_action.get("data");    // Optional
                    if (confirm == null) {
                        confirm = false;
                    }
                }
                if (type != null && name != null) {
                    if (type.equals("toggle") && entity != null) {
                        addItem(HomeAssistantMenuItemFactory.create().toggle(name, entity, content, confirm, pin));
                    } else if ((type.equals("tap") && service != null) || (type.equals("info") && content != null) || (type.equals("template") && content != null)) {
                        // NB. "template" is deprecated in the schema and remains only for backward compatibility. All menu items can now use templates, so the replacement is "info".
                        addItem(HomeAssistantMenuItemFactory.create().tap(name, entity, content, service, confirm, pin, data));
                    } else if (type.equals("group")) {
                        addItem(HomeAssistantMenuItemFactory.create().group(items[i], content));
                    }
                }
            }
        }
    }

    //! Return a list of items that need to be updated within this menu structure.
    //!
    //! MN. Lang.Array.addAll() fails structural type checking without including "Null" in the return type
    //!
    //! @return An array of menu items that need to be updated periodically to reflect the latest Home Assistant state.
    //
    function getItemsToUpdate() as Lang.Array<HomeAssistantToggleMenuItem or HomeAssistantTapMenuItem or HomeAssistantGroupMenuItem or Null> {
        var fullList = [];
        var lmi = mItems as Lang.Array<WatchUi.MenuItem>;

        for(var i = 0; i < mItems.size(); i++) {
            var item = lmi[i];
            if (item instanceof HomeAssistantGroupMenuItem) {
                // Group menu items can now have an optional template to evaluate
                var gmi = item as HomeAssistantGroupMenuItem;
                if (gmi.hasTemplate()) {
                    fullList.add(item);
                }
                fullList.addAll(item.getMenuView().getItemsToUpdate());
            } else if (item instanceof HomeAssistantToggleMenuItem) {
                fullList.add(item);
            } else if (item instanceof HomeAssistantTapMenuItem) {
                var tmi = item as HomeAssistantTapMenuItem;
                if (tmi.hasTemplate()) {
                    fullList.add(item);
                }
            }
        }

        return fullList;
    }

    //! Called when this View is brought to the foreground. Restore
    //! the state of this View and prepare it to be shown. This includes
    //! loading resources into memory.
    function onShow() as Void {}

}

//! Delegate for the HomeAssistantView.
//!
//! Reference: https://developer.garmin.com/connect-iq/core-topics/input-handling/
//
class HomeAssistantViewDelegate extends WatchUi.Menu2InputDelegate {
    private var mIsRootMenuView as Lang.Boolean = false;
    private var mTimer          as QuitTimer;

    //! Class Constructor
    //!
    //! @param isRootMenuView As menus can be nested, this state marks the top level menu so that the
    //!                       back event can exit the application completely rather than just popping
    //!                       a menu view.
    //
    function initialize(isRootMenuView as Lang.Boolean) {
        Menu2InputDelegate.initialize();
        mIsRootMenuView = isRootMenuView;
        mTimer          = getApp().getQuitTimer();
    }

    //! Back button event
    //
    function onBack() {
        mTimer.reset();

        if (mIsRootMenuView) {
            // If its started from glance or as an activity, directly exit the widget/app
            // (on widgets without glance, this exit() won't do anything,
            // so the base view will be shown instead, through the popView below this "if body")
            System.exit();
        }

        WatchUi.popView(WatchUi.SLIDE_RIGHT);
    }

    //! Only for CheckboxMenu
    //
    function onDone() {
        mTimer.reset();
    }

    //! Only for CustomMenu
    //
    function onFooter() {
        mTimer.reset();
    }

    //! Select event
    //!
    //! @param item Selected menu item.
    //
    function onSelect(item as WatchUi.MenuItem) as Void {
        mTimer.reset();
        if (item instanceof HomeAssistantToggleMenuItem) {
            var haToggleItem = item as HomeAssistantToggleMenuItem;
            // System.println(haToggleItem.getLabel() + " " + haToggleItem.getId() + " " + haToggleItem.isEnabled());
            haToggleItem.callService(haToggleItem.isEnabled());
        } else if (item instanceof HomeAssistantTapMenuItem) {
            var haItem = item as HomeAssistantTapMenuItem;
            // System.println(haItem.getLabel() + " " + haItem.getId());
            haItem.callService();
        } else if (item instanceof HomeAssistantGroupMenuItem) {
            var haMenuItem = item as HomeAssistantGroupMenuItem;
            // System.println("IconMenu: " + haMenuItem.getLabel() + " " + haMenuItem.getId());
            WatchUi.pushView(haMenuItem.getMenuView(), new HomeAssistantViewDelegate(false), WatchUi.SLIDE_LEFT);
        // } else {
        //     System.println(item.getLabel() + " " + item.getId());
        }
    }

    //! Only for CustomMenu
    //
    function onTitle() {
        mTimer.reset();
    }

}