Skip to main content

Python library for Marty the Robot V1 and V2

Project description

martypy

Python library to communicate with Marty the Robot V1 and V2 by Robotical

See the API Documentation

To regenerate documentation:

  • pip install -r dev-requirements.txt
  • pydoc-markdown --server --open
  • markdown_mmd api-documentation-edited.md -t dokuwiki -o docs-wiki.wiki OR, automatically:
  • run docgen.bat (or docgen.sh on Mac/Linux) from Python environment (will also create a docs-wiki.wiki file with the dokuwiki format)

NOTE: Make sure pandoc is installed on your system to generate the dokuwiki documentation. You can install pandoc from here

How to run example scripts

If you cloned the repository or downloaded the source code to try the example scripts, you will need to make sure you have MartyPy installed before you can run the examples.

The easiest way to install MartyPy is with the pip install martypy script as explained in step 2 here.

Once martypy is installed you can run each example using python. The following (for the dance example) assumes you have connected your marty using the USB cable to a Windows computer

python example_dance.py USB

To run the sound example over WiFi when your Marty is connected on IP address 192.168.86.10, use:

python example_sound.py WiFi 192.168.0.10

If you would like to make modifications to the martypy library itself, it will be better to install it from source using the command pip install --editable /path/to/martypy/repo (replacing /path/to/martypy/repo as appropriate of course).

If you do not want to "pip install" the MartyPy library, you can add the following 4 lines at the top (before any other code) of each script you want to run:

import sys
import pathlib
cur_path = pathlib.Path(__file__).parent.resolve()
sys.path.append(str(cur_path.parent.resolve()))

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

martypy-3.7.1.tar.gz (71.8 kB view details)

Uploaded Source

Built Distribution

martypy-3.7.1-py2.py3-none-any.whl (80.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file martypy-3.7.1.tar.gz.

File metadata

  • Download URL: martypy-3.7.1.tar.gz
  • Upload date:
  • Size: 71.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for martypy-3.7.1.tar.gz
Algorithm Hash digest
SHA256 5a9a12e7471fe6d95264ac57b2e5ec9d7575ca0df4867d31de883675fc80ed24
MD5 1611b9361220a81ab86d1d41d303efc4
BLAKE2b-256 72f84d747e1a4f51ea0e435aaefd3efd44c21503bee349c8e05c19caa5d817c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for martypy-3.7.1.tar.gz:

Publisher: build-publish.yml on robotical/martypy

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

File details

Details for the file martypy-3.7.1-py2.py3-none-any.whl.

File metadata

  • Download URL: martypy-3.7.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 80.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for martypy-3.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3875ce0bfbaed01644f79a62e1419ffdb652ad219d9eda1bcdde9d7fb2c0837f
MD5 4292dfe2ff7fa25dfeffece5c984b7c8
BLAKE2b-256 a4d55db39ffdf983f1871f29d1f4c60231c17b4b2aaa9840c8f1ab01c69c3ee8

See more details on using hashes here.

Provenance

The following attestation bundles were made for martypy-3.7.1-py2.py3-none-any.whl:

Publisher: build-publish.yml on robotical/martypy

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page