Rhasspy Grocy Skill (Rhasspy_App_Grocy)

A skill for Rhasspy that allows a user to interact with the open source ERP for you home, Grocy. This skill is implemented as a Hermes app and uses the Rhasspy-hermes-app library. The script can be run as a service, or as a docker container (recommended).

Installing

Requires:

• rhasspy-hermes-app 1.1.2
• pygrocy 1.5.0

In Docker:

To install, clone the repository and execute docker build to build the image.

sudo docker build hermes-app-grocy -t <image_name>

In Rhasspy:

Create a new sentence file and copy the sentences from the sentences.ini into the new file in Rhasspy and save. Retrain Rhasspy.

Setup the slot program:

1. SSH into the Rhasspy device
   • If using a base/satellite setup this is typically done on the base
2. Navigate to your slot programs folder
   • for example "/profiles/en/slot_programs"

cd /profiles/en/slot_programs

3. Create a folder name "grocy" and navigate to it

mkdir grocy
cd grocy

4. Download the slot program from the github repo

wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/batteries
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/chores
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/locations
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/products
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/quantity_units
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/shopping_lists
wget https://raw.githubusercontent.com/MCHellspawn/hermes-app-grocy/master/slot_programs/users

5. Setup the slot variables

batteries = $grocy/batteries
chores = $grocy/chores
products = $grocy/products
locations = $grocy/locations
quantity_units = $grocy/quantity_units
shoppinglists = $grocy/shopping_lists
users = $grocy/users

6. Use the slot variables in a sentence

Purchase (1..1000){quantity} (<quantity_units>){measure} [of] (<products>){product} into [the] (<locations>){location}
Complete [the] (<chores>){chore} chore

Configuration

Edit the setup section with the connection settings for Grocy and Rhasspy:

[setup]
host = http://grocy.local
port = 80
verifyssl = False
apikey = apikey

[Rhasspy]
# May be http or https
protocol = http
# Hostname or IP for Rhasspy intent recognition device
host = rhasspybase.local
# Port for Rhasspy device used above
port = 12101

• Grocy

  • host: string - URL of the Grocy Hostname/IP
  • port: integer - IP Port of the Grocy web API
  • verifyssl: boolean - Verify SSL certificate
  • apikey: string - API Key from Grocy

• Rhasspy

  • protocol: string - http or https
  • host: string - URL of the Rhasspy device handling intent recognition
  • port: integer - IP Port of the Rhasspy device handling intent recognition

Using

Build a docker container using the image created above. Bind the config volume <path/on/host>:/app/config

sudo docker run -it -d \
        --restart always \
        --name <container_name> \
        -v <path/on/host>:/app/config \
        -e "MQTT_HOST=<MQTT Host/IP>" \
        -e "MQTT_PORT=<MQTT Port (Typically:1883)" \
        -e "MQTT_USER=<MQTT User>" \
        -e "MQTT_PASSWORD=<MQTT Password>" \
        <image_name>

The following intents are implemented on the hermes MQTT topic:

[GrocyGetLocations]

[GrocyPurchaseProduct]

[GrocyCreateProduct]

[GrocyGetProductInventory]

[GrocyGetChores]

[GrocyTrackChore]

[GrocyGetShoppingLists]

[GrocyCreateShoppingList]

[GrocyAddProductToShoppingList]

[GrocyRemoveProductFromShoppingList]

[GrocyGetBatteries]

[GrocyGetBatteryNextCharge]

[GrocyTrackBatteryCharge]

To-Do

• Clean up install process
• More intents
  • Products
    • "Purchase" - Complete
    • Create - Complete - very basic only
      • want to extend this to a conversation
    • Transfer - Complete
    • Inventory
    • Consume - Complete - basic
    • Stock Listing
      • All
      • By location - Complete
      • By product type
      • By product - Complete
        • Include child items
  • Shopping lists
    • List - Complete
    • Create - Complete - basic only
    • Remove?
    • Add items
      • By product - Complete - basic only
      • By "below min stock"
      • By "expired"
      • By recipe
    • Remove items
      • By product - Complete - basic only
      • Push items to stock
  • Recipies
    • Consume ingredients
  • Chores
    • Assign
    • Complete/Skip - Complete - basic only
      • Complete/skip by person
    • List - Complete
      • All - Complete
      • Per person - Complete
  • Batteries
    • List - Complete
    • Get Charge - Complete
    • Change/Track - Complete
  • Locations
    • List - Complete
    • Create
• Slot programs
  • people/users - Complete
  • products - Complete
  • locations - Complete
  • chores - Complete
  • quantity_units - Complete
  • batteries - Complete
  • recipes