https://github.com/jhansche/pybirdbuddy

https://github.com/jhansche/pybirdbuddy

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jhansche/pybirdbuddy
• Owner: jhansche
• Created: 2022-12-02T07:07:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-12T21:55:41.000Z (about 1 year ago)
• Last Synced: 2024-04-14T13:16:56.015Z (9 months ago)
• Language: Python
• Size: 282 KB
• Stars: 23
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pybirdbuddy

```python

import asyncio

import pprint

from birdbuddy.client import BirdBuddy

bb = BirdBuddy("[email protected]", "Pa$$w0rd")

# Using coroutines with async/await:

async def async_test():

    await bb.refresh()

    pprint.pprint(bb.feeders)

# Without async/await, including from a top-level module:

result = asyncio.run(bb.refresh())

pprint.pprint(result)

pprint.pprint(bb.feeders)

```

Note: only password login is supported currently. Google and other SSOs are not supported. If

you've already set up your Bird Buddy with SSO, one option could be to register a new account with

a password, and then redeem an invite code to your Bird Buddy under the new account. Some fields

will be missing (such as firmware versions and off-grid status).

The `feeders` property will be an array of feeders with the following fields:

```graphql

fragment ListFeederFields on FeederForPrivate {

  battery {

    charging    # Boolean

    percentage  # Int (93)

    state       # String (enum: "HIGH")

  }

  food {

    state       # String (enum: "LOW")

  }

  id            # String (UUID)

  name          # String

  signal {

    state       # String (enum: "HIGH")

    value       # Int (rssi: -41)

  }

  state         # String (enum: "READY_TO_STREAM")

  temperature {

    value       # Int

  }

}

```

## Translations

API responses can return translated strings by setting the client's `language_code` property.

Language codes are parsed using [`langcodes`](https://pypi.org/project/langcodes/)

```python

from birdbuddy import BirdBuddy

async def main():

    bb = BirdBuddy

    bb.language_code = "de"

    

    collections = await bb.refresh_collections()

    birds = [c.species.name for c in collections.values()]

    print(birds)

```