Skip to main content

An API wrapper for the Greenworks robotic lawn mower

Project description

GreenWorks-Core

GreenWorks-Core is a Python package that provides an API wrapper for the Greenworks robotic lawn mower, enabling you to authenticate, list devices, and retrieve mower status and properties.

Install

Install from PyPI (name subject to change if unpublished):

pip install GreenWorks

Quick start

from src.GreenWorksAPI.GreenWorksAPI import GreenWorksAPI

api = GreenWorksAPI("you@example.com", "your-password", "Europe/Copenhagen")
devices = api.get_devices()
for d in devices:
		print(d.name, d.is_online, d.operating_status.mower_main_state)

Logging

This library uses the standard Python logging module with a module-level logger. No handlers are configured by default (a NullHandler is attached), so logs are propagated to the host application.

Home Assistant

Home Assistant captures Python logs. To enable debug logs for this library, add to your configuration.yaml:

logger:
	default: warning
	logs:
		src.GreenWorksAPI: debug

You can also target a single module:

logger:
	logs:
		src.GreenWorksAPI.GreenWorksAPI: debug

Standalone scripts

import logging
logging.basicConfig(level=logging.INFO)

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

greenworks-0.1.0.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

greenworks-0.1.0.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file greenworks-0.1.0.0.tar.gz.

File metadata

  • Download URL: greenworks-0.1.0.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for greenworks-0.1.0.0.tar.gz
Algorithm Hash digest
SHA256 a283ee9ab1a0dfed7f5595ba4b4aa395b523b86ada4960f16d726e572fe45a19
MD5 bb4cca8fec6f726b1c77c3b7cec72101
BLAKE2b-256 4bd5a49ccee069e0188ed4b08914dda55bd45d6f3442ee864f7b75ae5df2e0bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for greenworks-0.1.0.0.tar.gz:

Publisher: publish-to-test-pypi.yml on Boes24/GreenWorks-Core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file greenworks-0.1.0.0-py3-none-any.whl.

File metadata

  • Download URL: greenworks-0.1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for greenworks-0.1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1a139ff89a08bfbcf785e1453afbd1434867c151e50f6690b6038af94827023
MD5 7b5fdd3947296f0ffc913b3f46d21178
BLAKE2b-256 8b977b786e19bbbc66161609c3d45ef00d1b19594e9d155f89235905c068c6f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for greenworks-0.1.0.0-py3-none-any.whl:

Publisher: publish-to-test-pypi.yml on Boes24/GreenWorks-Core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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