Skip to main content

Interface for interacting with Fellow Aiden coffee brewer

Project description

Fellow Aiden

PyPI version

This library provides an interface to the Fellow Aiden coffee brewer. An additional brew studio UI with support for AI-generated recipes is also included. You can run the Brew Studio locally on your system or make use of the hosted version: https://fellow-brew-studio.streamlit.app/

Fellow Brew Studio

Quick Start

Install the library:

pip install fellow-aiden
# or
python setup.py install

Set ENV variables:

export FELLOW_EMAIL='YOUR-EMAIL-HERE'
export FELLOW_PASSWORD='YOUR-PASSWORD-HERE'

Sample Code

This sample code shows some of the range of functionality within the library:

import os
from fellow_aiden import FellowAiden

# EMAIL = "YOUR-EMAIL-HERE"
# PASSWORD = "YOUR-PASSWORD-HERE"

EMAIL = os.environ['FELLOW_EMAIL']
PASSWORD = os.environ['FELLOW_PASSWORD']

# Create an instance
aiden = FellowAiden(EMAIL, PASSWORD)

# Get display name of brewer
name = aiden.get_display_name()

# Get profiles
profiles = aiden.get_profiles()

# Add a profile
profile = {
    "profileType": 0,
    "title": "Debug-FellowAiden",
    "ratio": 16,
    "bloomEnabled": True,
    "bloomRatio": 2,
    "bloomDuration": 30,
    "bloomTemperature": 96,
    "ssPulsesEnabled": True,
    "ssPulsesNumber": 3,
    "ssPulsesInterval": 23,
    "ssPulseTemperatures": [96,97,98],
    "batchPulsesEnabled": True,
    "batchPulsesNumber": 2,
    "batchPulsesInterval": 30,
    "batchPulseTemperatures": [96,97]
}
aiden.create_profile(profile)

# Find profile
pid = None
option = aiden.get_profile_by_title('FellowAiden', fuzzy=True)
if option:
    pid = option['id'] # p0

# Share a profile
share_link = aiden.generate_share_link(pid)

# Delete a profile
aiden.delete_profile_by_id(pid)

# Add profile from shared brew link
aiden.create_profile_from_link('https://brew.link/p/ws98')

# Add a schedule
schedule = {
    "days": [True, True, False, True, False, True, False], // sunday - saturday
    "secondFromStartOfTheDay": 28800, // time since 12 am
    "enabled": True,
    "amountOfWater": 950, // 150 - 1500
    "profileId": "p7", // must be valid profile
}
aiden.create_schedule(schedule)

# Delete a schedule
aiden.delete_schedule_by_id('s0')

Features

  • Access all settings and details from Aiden brewer
  • Manage custom brewing profiles
  • Add shared profiles from URL
  • Generate share links from custom profiles
  • Search profiles using title (match and fuzzy)
  • Manage custom brewing schedules
  • Brew Studio UI with support for AI, Brew Links and Profile adjustments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fellow_aiden-0.2.1.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fellow_aiden-0.2.1-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file fellow_aiden-0.2.1.tar.gz.

File metadata

  • Download URL: fellow_aiden-0.2.1.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for fellow_aiden-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d1b735bfa260e9863e81b4011e3f287531668e564fbde5f4b4eb661a45ef2c50
MD5 572042df7a7157788f7f2234030c4965
BLAKE2b-256 c35099664ef2686e435e3dca1b1e05e9f21f3e4a1a71f185e3e28284aff88bda

See more details on using hashes here.

File details

Details for the file fellow_aiden-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: fellow_aiden-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for fellow_aiden-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cfb7ee7fc108e848a56abaae901ffdb83fe2180ffbf7c4c061cfce94430a698
MD5 909670a864ce6eaafa57d5ddf6678451
BLAKE2b-256 2cd31619ba16058a9a1bf27286275c7fa26eb9cb646cada93ab6746ebfc6299e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page