Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A self-hosted dashboard for monitoring and controlling multiple TinyPilot device
## What you get

- One web UI that lists your TinyPilot devices, up to four per page, with a live preview of the connected system on each card (cached in the browser only).
- One-click device addition (friendly name + TinyPilot URL + Automation API key), plus Replace API key on an existing card.
- One-click device addition (friendly name + TinyPilot URL + Automation API key), plus rename and Replace API key on an existing card.
- Per-device snapshot of TinyPilot status: connected display resolution, streaming mode (H.264 with bitrate, or MJPEG with framerate and quality), firmware version, network info, and more.
- Encrypted at-rest storage for Automation API keys.

Expand Down
72 changes: 72 additions & 0 deletions app/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@

api_blueprint = Blueprint('api', __name__, url_prefix='/api')

_FRIENDLY_NAME_MAX = 60


@api_blueprint.get('/version')
def get_version():
Expand Down Expand Up @@ -125,6 +127,10 @@ def create_device():
return jsonify(
{'error': 'friendly_name, base_url, and api_key are required'}
), 400
if len(friendly_name) > _FRIENDLY_NAME_MAX:
return jsonify(
{'error': 'friendly_name must be 60 characters or fewer'}
), 400

key_path = Path(current_app.config['SECRET_KEY_PATH'])
db = get_db()
Expand Down Expand Up @@ -174,6 +180,72 @@ def create_device():
), 201


@api_blueprint.put('/devices/<int:device_id>')
def update_device_friendly_name(device_id: int):
payload = request.get_json(silent=True) or {}
raw_name = payload.get('friendly_name') if isinstance(payload, dict) else None
if not isinstance(raw_name, str) or not raw_name.strip():
return jsonify({'error': 'friendly_name is required'}), 400
friendly_name = raw_name.strip()
if len(friendly_name) > _FRIENDLY_NAME_MAX:
return jsonify(
{'error': 'friendly_name must be 60 characters or fewer'}
), 400

db = get_db()
existing = db.execute(
"""
SELECT id
FROM devices
WHERE id = ?
""",
(device_id,),
).fetchone()
if existing is None:
return jsonify({'error': 'device not found'}), 404

db.execute(
"""
UPDATE devices
SET friendly_name = ?
WHERE id = ?
""",
(friendly_name, device_id),
)
db.commit()
row = db.execute(
"""
SELECT
devices.id,
devices.friendly_name,
devices.base_url,
device_runtime_state.screenshot_refresh_interval_minutes,
CASE
WHEN device_auth.encrypted_automation_token IS NOT NULL THEN 1
ELSE 0
END AS api_key_configured
FROM devices
LEFT JOIN device_runtime_state ON device_runtime_state.device_id = devices.id
LEFT JOIN device_auth ON device_auth.device_id = devices.id
WHERE devices.id = ?
""",
(device_id,),
).fetchone()
return jsonify(
{
'device': {
'id': row['id'],
'friendly_name': row['friendly_name'],
'base_url': row['base_url'],
'screenshot_refresh_interval_minutes': (
row['screenshot_refresh_interval_minutes'] or 0
),
'api_key_configured': bool(row['api_key_configured']),
}
}
)


@api_blueprint.delete('/devices/<int:device_id>')
def delete_device(device_id: int):
db = get_db()
Expand Down
37 changes: 37 additions & 0 deletions app/static/css/dashboard.css
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,43 @@ summary {

.device-card-header .device-card-title {
min-width: 0;
flex: 1;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}

.device-card-title-cluster {
display: flex;
align-items: center;
flex-wrap: wrap;
gap: var(--space-2);
min-width: 0;
flex: 1;
}

.device-rename-form {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: var(--space-2);
min-width: 0;
flex: 1;
}

.device-rename-form[hidden] {
display: none;
}

.device-rename-form input {
min-width: 0;
flex: 1 1 8rem;
}

.device-card-header .device-rename-error {
flex-basis: 100%;
margin: 0;
color: var(--color-nav-text);
}

.header-open-webui {
Expand Down
94 changes: 93 additions & 1 deletion app/static/js/components/device-card.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ class DeviceCard extends HTMLElement {
this._capturedAt = null;
this._objectUrl = null;
this._previewState = 'loading';
this._renameSeq = 0;
this._renameSaving = false;
}

set device(value) {
Expand Down Expand Up @@ -160,7 +162,16 @@ class DeviceCard extends HTMLElement {
this.innerHTML = `
<section class="panel device-card">
<header class="device-card-header">
<h3 class="device-card-title">${escapeHtml(device.friendly_name)}</h3>
<div class="device-card-title-cluster">
<h3 class="device-card-title">${escapeHtml(device.friendly_name)}</h3>
<button type="button" class="device-rename" data-rename="start">Rename</button>
<form class="device-rename-form" hidden>
<input name="friendly_name" maxlength="60" autocomplete="off" aria-label="Friendly name">
<button type="submit">Save</button>
<button type="button" data-rename="cancel">Cancel</button>
<p class="device-rename-error" hidden></p>
</form>
</div>
${renderHeaderOpenWebUi(device)}
</header>
<section class="device-section connected-system">
Expand Down Expand Up @@ -235,10 +246,91 @@ class DeviceCard extends HTMLElement {
</section>
`;
this._cacheElements();
this._bindRename();
this._showLoadingPlaceholder();
void this._primeFromCache();
}

_bindRename() {
const header = this.querySelector('.device-card-header');
const title = header.querySelector('.device-card-title');
const start = header.querySelector('[data-rename="start"]');
const form = header.querySelector('.device-rename-form');
const input = form.querySelector('input[name="friendly_name"]');
const error = form.querySelector('.device-rename-error');
const showError = (text) => {
error.hidden = !text;
error.textContent = text || '';
};
const closeEditor = () => {
// Bump the seq so an in-flight save cannot apply after Cancel.
this._renameSeq += 1;
this._renameSaving = false;
form.hidden = true;
title.hidden = false;
start.hidden = false;
showError('');
};
start.addEventListener('click', () => {
input.value = this._device.friendly_name;
showError('');
title.hidden = true;
start.hidden = true;
form.hidden = false;
input.focus();
});
form.querySelector('[data-rename="cancel"]').addEventListener('click', closeEditor);
input.addEventListener('keydown', (event) => {
if (event.key === 'Escape') {
event.preventDefault();
closeEditor();
}
});
form.addEventListener('submit', async (event) => {
event.preventDefault();
if (this._renameSaving) {
return;
}
const typed = input.value.trim();
if (!typed) {
showError('Enter a name.');
return;
}
this._renameSaving = true;
const seq = this._renameSeq;
const result = await window.dashboardApi.putJson(
`/api/devices/${this._device.id}`,
{ friendly_name: typed },
);
if (seq !== this._renameSeq) {
return;
}
this._renameSaving = false;
if (result.error) {
showError(result.error);
return;
}
const saved = result.device && result.device.friendly_name;
if (typeof saved !== 'string' || !saved.trim()) {
showError('Could not rename this device.');
return;
}
// ponytail: write the name in place. Assigning this.device calls
// _render() and drops the preview. The page list holds this object.
this._device.friendly_name = saved;
title.textContent = saved;
const link = this.querySelector(`#connected-screenshot-link-${this._device.id}`);
const image = this.querySelector(`#connected-screenshot-${this._device.id}`);
if (link) {
link.setAttribute('aria-label', `Control ${saved}`);
}
if (image) {
image.alt = `Latest screenshot for ${saved}`;
}
closeEditor();
});
}

_showLoadingPlaceholder() {
const { screenshot, placeholder, frame } = this._elements;
if (screenshot) {
Expand Down
2 changes: 1 addition & 1 deletion app/static/js/dashboard-app.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class DashboardApp extends HTMLElement {
<form id="add-device-form" class="form-grid">
<label>
Friendly name
<input name="friendly_name" required autocomplete="off">
<input name="friendly_name" required maxlength="60" autocomplete="off">
</label>
<label>
TinyPilot device URL
Expand Down
85 changes: 85 additions & 0 deletions tests/test_api_connections.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,91 @@ def test_create_device_rejects_blank_api_key(client):
assert response.status_code == 400


def test_rename_device_persists_friendly_name(client):
create_response = client.post('/api/devices', json={
'friendly_name': 'Office Rack KVM',
'base_url': 'https://192.168.1.44',
'api_key': 'test-api-key',
})
device_id = create_response.json['device']['id']

response = client.put(
f'/api/devices/{device_id}',
json={'friendly_name': ' Lab Rack '},
)
assert response.status_code == 200
device = response.json['device']
assert device['friendly_name'] == 'Lab Rack'
assert device['base_url'] == 'https://192.168.1.44'
assert device['api_key_configured'] is True
assert 'screenshot_refresh_interval_minutes' in device

listed = client.get('/api/devices').json['devices']
assert listed[0]['friendly_name'] == 'Lab Rack'


def test_rename_device_rejects_blank_name(client):
create_response = client.post('/api/devices', json={
'friendly_name': 'Office Rack KVM',
'base_url': 'https://192.168.1.44',
'api_key': 'test-api-key',
})
device_id = create_response.json['device']['id']

response = client.put(
f'/api/devices/{device_id}',
json={'friendly_name': ' '},
)
assert response.status_code == 400
assert response.json['error'] == 'friendly_name is required'
listed = client.get('/api/devices').json['devices']
assert listed[0]['friendly_name'] == 'Office Rack KVM'


def test_friendly_name_rejects_more_than_60_characters(client):
long_name = 'R' * 61
create_response = client.post('/api/devices', json={
'friendly_name': long_name,
'base_url': 'https://192.168.1.44',
'api_key': 'test-api-key',
})
assert create_response.status_code == 400
assert create_response.json['error'] == (
'friendly_name must be 60 characters or fewer'
)

created = client.post('/api/devices', json={
'friendly_name': 'Office Rack KVM',
'base_url': 'https://192.168.1.44',
'api_key': 'test-api-key',
})
device_id = created.json['device']['id']
rename_response = client.put(
f'/api/devices/{device_id}',
json={'friendly_name': long_name},
)
assert rename_response.status_code == 400
assert rename_response.json['error'] == (
'friendly_name must be 60 characters or fewer'
)
listed = client.get('/api/devices').json['devices']
assert listed[0]['friendly_name'] == 'Office Rack KVM'

ok_name = 'R' * 60
ok_response = client.put(
f'/api/devices/{device_id}',
json={'friendly_name': ok_name},
)
assert ok_response.status_code == 200
assert ok_response.json['device']['friendly_name'] == ok_name


def test_rename_device_missing_returns_404(client):
response = client.put('/api/devices/999', json={'friendly_name': 'Lab'})
assert response.status_code == 404
assert response.json['error'] == 'device not found'


def test_delete_device_removes_device_and_related_rows(client):
payload = {
'friendly_name': 'Delete Me',
Expand Down
11 changes: 11 additions & 0 deletions tests/test_remove_device_ui.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,17 @@ def test_circleci_runs_core_and_security_jobs():
assert './dev-scripts/check-javascript' in config


def test_device_card_renames_from_the_title():
source = CARD.read_text(encoding='utf-8')
assert 'data-rename="start"' in source
assert 'maxlength="60"' in source
assert 'maxlength="60"' in APP.read_text(encoding='utf-8')
assert 'Enter a name.' in source
assert 'Could not rename this device.' in source
assert 'data-action="rename"' not in source
assert 'window.prompt(' not in APP.read_text(encoding='utf-8')


def test_screenshot_click_opens_device_webui():
source = CARD.read_text(encoding='utf-8')
assert 'Open latest screenshot in new tab' not in source
Expand Down
Loading