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.0.3.0.tar.gz (6.2 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.0.3.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for greenworks-0.0.3.0.tar.gz
Algorithm Hash digest
SHA256 5edda4cf1cfc5beaee0b45647b6ac361541304a4ddf00f373990d6ca33669c18
MD5 6e64128ba8cb812b59567a606bf93b7c
BLAKE2b-256 fd799bde2625ff28ec77299aa2a6472cff62363a1d4483212070dce818114b6c

See more details on using hashes here.

Provenance

The following attestation bundles were made for greenworks-0.0.3.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.0.3.0-py3-none-any.whl.

File metadata

  • Download URL: greenworks-0.0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 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.0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4b51e50dc92a17bca32c88f5d00d06a01f56c2da1ee0be59c05bfdeae8dffc8
MD5 34bf07ed3f7d6b846a84812faf6d1ec8
BLAKE2b-256 91041f9d00cd176928907ead506b51b49470503c07dc3208e29dd3a888bcf1bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for greenworks-0.0.3.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