Skip to content

docs(#14): add comprehensive API reference documentation - #256

Open
dennismdejong wants to merge 1 commit into
jjjonesjr33:devfrom
dennismdejong:fix/upstream-14
Open

docs(#14): add comprehensive API reference documentation#256
dennismdejong wants to merge 1 commit into
jjjonesjr33:devfrom
dennismdejong:fix/upstream-14

Conversation

@dennismdejong

Copy link
Copy Markdown

Fixes #14

Adds a comprehensive API reference document (docs/api-documentation.md) documenting all known Petlibro API endpoints, their request/response formats, and field descriptions.

Covered endpoints:

  • Authentication (/member/auth/login)
  • Device management (list, baseInfo, realInfo, dataRealInfo, attributeSettings)
  • Feeding plans (dry + wet)
  • Fountain water modes and drinking data
  • Litter box commands and configuration
  • Events and work records
  • Pet management and RFID collar data
  • All control/setting endpoints
  • Member/account info

All documentation is based on reverse-engineering the code in api.py and the device classes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Wiki]: Document API response structures

1 participant