TinyPilot REST API

#!/usr/bin/env python3
"""Exercise all the functionality of the TinyPilot REST API.

This script performs the following actions:

1. Open a terminal on the target machine by pressing `Ctrl` + `Alt` + `T`.
2. Paste `echo "Hello, World!"` and then press the `Enter` key on the target machine.
3. Open Firefox.
4. Navigate to https://paint.js.org.
5. Draw a rectangle in paint.
6. Save a screenshot of the target machine display.

Create an API key in System > Automation, then set API_KEY below.
"""

import json
import ssl
import sys
import time
import urllib.error
import urllib.request

BASE_URL = 'https://tinypilot/api/v1'
API_KEY = '[API_KEY]'

# Seconds to wait after each keystroke to allow it to finish delivering
# before sending subsequent input.
SECONDS_PER_KEYSTROKE = 0.1

# Disable SSL verification
# This is not necessary if you install your TinyPilot device's CA
# certificate:
# https://tinypilotkvm.com/faq/fix-browser-privacy-errors
# Example:
#   ctx = ssl.create_default_context(cafile='/path/to/tinypilot/ca.crt')
ctx = ssl.create_default_context()
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE


def main():
    # Use API key from System > Automation.
    token = API_KEY

    # 1. Open a terminal by pressing `Ctrl` + `Alt` + `T`.

    print('Opening terminal...', end='', flush=True)
    payload = {
        'code': 'KeyT',
        'ctrlLeft': True,
        'altLeft': True,
    }
    req = urllib.request.Request(url=f'{BASE_URL}/keystroke',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(SECONDS_PER_KEYSTROKE)
    print(' done.')

    print('Waiting 3s for the terminal to open...', end='', flush=True)
    time.sleep(3)
    print(' done.')

    # 2. Paste `echo "Hello, World!"` then press `Enter`.
    print('Pasting text...', end='', flush=True)
    text = 'echo "Hello, World!"'
    payload = {
        'text': text,
        'language': 'en-US',
    }
    req = urllib.request.Request(url=f'{BASE_URL}/paste',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(len(text) * SECONDS_PER_KEYSTROKE)
    payload = {'code': 'Enter'}
    req = urllib.request.Request(url=f'{BASE_URL}/keystroke',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(SECONDS_PER_KEYSTROKE)
    print(' done.')

    print('Waiting 1s for command to execute...', end='', flush=True)
    time.sleep(1)
    print(' done.')

    # 3. Open Firefox.
    print('Opening Firefox...', end='', flush=True)
    text = 'firefox'
    payload = {
        'text': text,
        'language': 'en-US',
    }
    req = urllib.request.Request(url=f'{BASE_URL}/paste',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(len(text) * SECONDS_PER_KEYSTROKE)
    payload = {'code': 'Enter'}
    req = urllib.request.Request(url=f'{BASE_URL}/keystroke',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(SECONDS_PER_KEYSTROKE)
    print(' done.')

    print('Waiting 3s for command to execute...', end='', flush=True)
    time.sleep(3)
    print(' done.')

    # 4. Navigate to paint.js.org.
    print('Navigating to paint.js.org...', end='', flush=True)
    payload = {
        'code': 'KeyL',
        'ctrlLeft': True,
    }
    req = urllib.request.Request(url=f'{BASE_URL}/keystroke',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(SECONDS_PER_KEYSTROKE)
    text = 'https://paint.js.org/'
    payload = {
        'text': text,
        'language': 'en-US',
    }
    req = urllib.request.Request(url=f'{BASE_URL}/paste',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(len(text) * SECONDS_PER_KEYSTROKE)
    payload = {'code': 'Enter'}
    req = urllib.request.Request(url=f'{BASE_URL}/keystroke',
                                 method='POST',
                                 headers={
                                     'Authorization': f'Bearer {token}',
                                     'Content-Type': 'application/json'
                                 },
                                 data=json.dumps(payload).encode())
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            pass
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    time.sleep(SECONDS_PER_KEYSTROKE)
    print(' done.')

    print('Waiting 5s for command to execute...', end='', flush=True)
    time.sleep(5)
    print(' done.')

    # 5. Draw a rectangle in paint.
    print('Drawing rectangle...', end='', flush=True)
    payloads = [
        {
            'relativeX': 0.25,
            'relativeY': 0.25,
            'buttons': 0,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.25,
            'relativeY': 0.25,
            'buttons': 1,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.75,
            'relativeY': 0.25,
            'buttons': 1,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.75,
            'relativeY': 0.75,
            'buttons': 1,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.25,
            'relativeY': 0.75,
            'buttons': 1,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.25,
            'relativeY': 0.25,
            'buttons': 1,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
        {
            'relativeX': 0.25,
            'relativeY': 0.25,
            'buttons': 0,
            'verticalWheelDelta': 0,
            'horizontalWheelDelta': 0,
        },
    ]
    for payload in payloads:
        req = urllib.request.Request(url=f'{BASE_URL}/mouseEvent',
                                     method='POST',
                                     headers={
                                         'Authorization': f'Bearer {token}',
                                         'Content-Type': 'application/json'
                                     },
                                     data=json.dumps(payload).encode())
        try:
            with urllib.request.urlopen(req, context=ctx) as response:
                pass
        except urllib.error.HTTPError as e:
            print(f'HTTP Error {e.status}: {e.read().decode()}',
                  file=sys.stderr)
            return
    print(' done.')

    print('Waiting 1s for command to execute...', end='', flush=True)
    time.sleep(1)
    print(' done.')

    # 6. Save a screenshot of the display.
    print('Taking a screenshot...', end='', flush=True)
    req = urllib.request.Request(url=f'{BASE_URL}/screenshot',
                                 method='GET',
                                 headers={'Authorization': f'Bearer {token}'})
    try:
        with urllib.request.urlopen(req, context=ctx) as response:
            with open('screenshot.jpeg', 'wb') as f:
                f.write(response.read())
    except urllib.error.HTTPError as e:
        print(f'HTTP Error {e.status}: {e.read().decode()}', file=sys.stderr)
        return
    print(' done.')


if __name__ == '__main__':
    main()