farmware-tools 3.5.6

Farmware convenience functions for use in FarmBot OS.

Farmware Tools

Tools for use by Farmware. Starting with FarmBot OS v6.4.2, this package is installed automatically and available for Farmware to import. See the sections below for other installation configurations.

Example

from farmware_tools import device
device.log('hello')

If the above code is run within a Farmware, FarmBot OS will send a hello log to the FarmBot Web App.

If the above code is run elsewhere, the output will be the command that would have been sent to FarmBot OS:

{'kind': 'send_message', 'args': {'message': 'hello', 'message_type': 'info'}}

Documentation

In addition to the Farmware development documentation, a list of available functions is available via the Python console:

from farmware_tools import app, device
help(app)
help(device)

Local installation (for local Farmware development)

pip install farmware-tools

user-level install: pip install --user farmware-tools

upgrade: pip install --user --upgrade farmware-tools

install a specific version: pip install --user farmware-tools==1.0.0

Specifying a version in a Farmware manifest

"farmware_tools_version": "v1.0.0"

By including this line in a Farmware manifest, FarmBot OS will automatically install the specified version and make it available to import from within the Farmware.