https://github.com/joonas-fi/shopping-list-manager
Listen for barcode scans from a barcode reader and add their product names to shopping list
https://github.com/joonas-fi/shopping-list-manager
Last synced: about 1 month ago
JSON representation
Listen for barcode scans from a barcode reader and add their product names to shopping list
- Host: GitHub
- URL: https://github.com/joonas-fi/shopping-list-manager
- Owner: joonas-fi
- License: apache-2.0
- Created: 2024-08-22T09:49:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-13T15:19:50.000Z (2 months ago)
- Last Synced: 2025-02-13T16:31:22.933Z (2 months ago)
- Language: Go
- Homepage: https://joonas.fi/
- Size: 193 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⬆️ For table of contents, click the above icon
Listen for barcode scans from a barcode reader and add their product names to shopping list
Overview
--------
```mermaid
flowchart TD
subgraph "Physical barcode reader"
barcodeentered[Barcode scanned]
end
subgraph "Todoist server"
shoppinglist[Shopping list]
end
subgraph "Todoist clients"
myphone[My phone]
familymemberphone[Family member's phones]
homeassistant[Home Assistant dashboard\nalways visible on our home wall]
end
subgraph "Shopping list manager"
foundfromlocalDB?[Have we seen this barcode before?\nCheck from our own local DB of before-seen barcodes]
useunnamedproduct[Have barcode whose product name\nwe don't yet know]
websearch[Do a web search\non Google]
aiextractproductname[Use ChatGPT to extract product name\nfrom web search result titles]
addtoshoppinglist[Add product name to shopping list]
namenotknown[ERROR: Product name not known]
end
barcodeentered --> foundfromlocalDB?
foundfromlocalDB? -- yes --> addtoshoppinglist
foundfromlocalDB? -- no --> useunnamedproduct --> websearch -- have results --> aiextractproductname -- success --> addtoshoppinglist
aiextractproductname -. success: store name\nso we know next time .-> foundfromlocalDB?
websearch -- no results --> namenotknown
aiextractproductname -- extraction fails --> namenotknown
addtoshoppinglist --> shoppinglist
namenotknown -. fallback: add bare barcode .-> shoppinglist
shoppinglist --> myphone
shoppinglist --> familymemberphone
shoppinglist --> homeassistant
```
How to run
----------
First source `app.env` (which has the ENV variables from the configuration section), then:
```shell
docker run --rm -it --device /dev/input/by-id/usb-NT_USB_Keyboard-event-kbd:/dev/barcode-reader -e OPENAI_API_KEY -e TODOIST_TOKEN -e TODOIST_PROJECT_ID -e GOOGLE_SEARCH_CUSTOM_SEARCH_ENGINE_ID -e GOOGLE_SEARCH_API_KEY ghcr.io/joonas-fi/shopping-list-manager:latest
```
Hardware
--------
Should work with any barcode reader that works on Linux. The wireless ones are really convenient.
I used this: [NETUM NT-1228BL](https://www.amazon.de/dp/B07CBS52KJ)
Configuration
-------------
You'll need to configure ENV variables:
- `BARCODE_READER` (example `/dev/input/by-id/usb-NT_USB_Keyboard-event-kbd`)
- `OPENAI_API_KEY` (create [here](https://platform.openai.com/api-keys))
- `TODOIST_TOKEN`
- `TODOIST_PROJECT_ID`
- `GOOGLE_SEARCH_CUSTOM_SEARCH_ENGINE_ID`
- `GOOGLE_SEARCH_API_KEY` (get [here](https://developers.google.com/custom-search/v1/overview))
- `WEBAPP_BASEURL` (optional) base URL of the web app (so we can make links back to it)
Resolving unknown barcodes
--------------------------
There are web APIs to barcode databases where you can resolve the product name from.
However those are either bad (only have small subset of real-world barcodes) or really expensive
(I'm not paying hundreds of dollars a month for this use case), so I opted to use web search as a "database".
External services
-----------------
- Todoist
- For resolving unknown barcodes:
* Google
* ChatGPT