Afbeelding uit een script
Een Python-script dat een grafiek tekent, er de vorige afbeelding in een playlist mee vervangt en publiceert. Cron draait het elke vijf minuten. De blokken op deze pagina vormen samen één bestand.
1 Haal een token op
Open de CMS op Instellingen, Verbonden apps en klik op Genereer token. Een lid zonder beheerdersrechten ziet dit tabblad niet.
Kies daarna de organisatie, die bepaalt welke schermen het programma ziet, en klik op Toestaan. De volgende pagina toont de client ID en het refresh token, één keer. Kopieer ze allebei.
Zet in je terminal de client ID en het pad naar het tokenbestand, en schrijf het refresh token naar dat bestand. read -rs wacht zonder iets te tonen: plak het refresh token en druk op Enter, zo blijft het uit de shell-history:
export GIBEON_CLIENT_ID=CLIENT_ID export GIBEON_REFRESH_TOKEN_FILE=./gibeon-refresh-token touch "$GIBEON_REFRESH_TOKEN_FILE" chmod 600 "$GIBEON_REFRESH_TOKEN_FILE" read -rs GIBEON_REFRESH_TOKEN && printf '%s' "$GIBEON_REFRESH_TOKEN" > "$GIBEON_REFRESH_TOKEN_FILE"
Installeer de twee dependencies in een venv, want Homebrew-Python en Debian 12 of nieuwer weigeren een pip install daarbuiten:
python3 -m venv .venv source .venv/bin/activate python3 -m pip install requests matplotlib
Zet de blokken hieronder in volgorde in gibeon.py en draai python3 gibeon.py.
2 Kies de playlist en het scherm
Het script heeft twee id’s nodig. De id van de playlist staat in de adresbalk van de CMS als je de playlist opent: /playlists/PLAYLIST_ID/content. De id van het scherm staat daar als je het scherm opent: /devices/PLAYER_ID.
export GIBEON_PLAYLIST_ID=PLAYLIST_ID export GIBEON_PLAYER_ID=PLAYER_ID
De playlist moet al op het scherm staan: dit script wijst haar niet toe. Dat doe je één keer met de laatste stap van de quickstart in Python, Node.js of Go, onderaan deze pagina gelinkt.
De playlist hoort alleen bij dit script: elke run verwijdert elk ouder item, wat het ook is. Neem dus een aparte playlist. Zet de playlist op dit ene scherm: het script publiceert alleen dat scherm, en een ander scherm met dezelfde playlist houdt een afbeelding vast die het script daarna verwijdert.
3 Vernieuw het token
Een access token is 60 minuten geldig. Elke vernieuwing geeft ook een nieuw refresh token, dus een waarde in de omgeving is na één run verouderd.
Het programma schrijft het nieuwe token naar een tijdelijk bestand in dezelfde map, zet chmod 600 en hernoemt het over het bestand in GIBEON_REFRESH_TOKEN_FILE. Daarna pas gebruikt het programma het access token. Een proces dat daarbij stopt, houdt zo een werkend refresh token over.
Elke aanvraag controleert de status: bij een fout stopt raise_for_status het programma met een exitcode die niet nul is.
import os
import tempfile
import requests
token_file = os.environ["GIBEON_REFRESH_TOKEN_FILE"]
with open(token_file) as f:
refresh_token = f.read().strip()
response = requests.post(
"https://id.gibeon.io/auth/v1/oauth/token",
data={
"grant_type": "refresh_token",
"client_id": os.environ["GIBEON_CLIENT_ID"],
"refresh_token": refresh_token,
},
timeout=30,
)
response.raise_for_status()
tokens = response.json()
# Store the new refresh token before anything uses the access token.
fd, tmp_path = tempfile.mkstemp(dir=os.path.dirname(token_file) or ".")
with os.fdopen(fd, "w") as f:
f.write(tokens["refresh_token"])
os.chmod(tmp_path, 0o600)
os.replace(tmp_path, token_file)
headers = {"Authorization": f"Bearer {tokens['access_token']}"} 4 Controleer het scherm en lees de playlist
Het script leest de twee id’s, vraagt het scherm op en leest de items van de playlist, en dat vóór het een asset aanmaakt. Is een id verouderd, dan stopt het hier en komt er geen afbeelding bij.
# Both are required: a missing one stops the run before it changes anything.
playlist_id = os.environ["GIBEON_PLAYLIST_ID"]
player_id = os.environ["GIBEON_PLAYER_ID"]
# A stale screen id stops the run here, before an asset exists.
response = requests.get(
f"https://www.gibeon.io/v1/players/{player_id}",
headers=headers,
timeout=30,
)
response.raise_for_status()
# Read before adding, so this list holds only the older items.
response = requests.get(
f"https://www.gibeon.io/v1/playlists/{playlist_id}/items",
headers=headers,
timeout=30,
)
response.raise_for_status()
older_items = response.json()["data"] 5 Teken de grafiek
Dit blok tekent vaste voorbeeldcijfers op 1920 bij 1080 pixels. Vervang ze door je eigen cijfers. Figure heeft geen scherm nodig, dus dit werkt ook onder cron. Een scherm toont de afbeelding op de grootte van de upload, dus teken ze op schermgrootte, zoals dit script op 1920 bij 1080.
Elke PNG werkt, ook die uit de Grafana image renderer.
from datetime import datetime
from matplotlib.figure import Figure
figure = Figure(figsize=(16, 9), dpi=120)
axes = figure.subplots()
axes.bar(["North", "East", "South", "West"], [12, 19, 7, 15])
axes.set_title(datetime.now().strftime("Updated at %H:%M"))
figure.savefig("chart.png") 6 Upload de afbeelding
Een upload heeft twee stappen. POST /v1/assets maakt het asset aan, daarna stuurt de PUT de bytes met Content-Type: image/png. De file_size mag maximaal 10 procent van de verstuurde bytes afwijken.
with open("chart.png", "rb") as f:
png = f.read()
response = requests.post(
"https://www.gibeon.io/v1/assets",
headers=headers,
json={
"name": "chart.png",
"asset_type": "image",
"mime_type": "image/png",
"file_size": len(png),
},
timeout=30,
)
response.raise_for_status()
asset_id = response.json()["data"]["id"]
response = requests.put(
f"https://www.gibeon.io/v1/assets/{asset_id}/upload",
headers={**headers, "Content-Type": "image/png"},
data=png,
timeout=60,
)
response.raise_for_status() 7 Vervang het item in de playlist
Het script gebruikt de items die het in de controlestap las, dus die lijst bevat alleen oudere items. Het voegt het nieuwe item toe en verwijdert daarna de oudere. Zo is de playlist nooit leeg.
response = requests.post(
f"https://www.gibeon.io/v1/playlists/{playlist_id}/items",
headers=headers,
json={"type": "image", "asset_id": asset_id, "duration_seconds": 30},
timeout=30,
)
response.raise_for_status()
for item in older_items:
item_id = item["id"]
response = requests.delete(
f"https://www.gibeon.io/v1/playlists/{playlist_id}/items/{item_id}",
headers=headers,
timeout=30,
)
response.raise_for_status() 8 Publiceer
Tot je publiceert, toont het scherm de vorige afbeelding. Publiceren bouwt een nieuwe snapshot en geeft het scherm meteen een seintje.
response = requests.post(
f"https://www.gibeon.io/v1/players/{player_id}/publish",
headers=headers,
timeout=30,
)
response.raise_for_status() 9 Verwijder de oudere afbeeldingen
Het script verwijdert alleen de assets van de items die het net weghaalde. Dat gebeurt na het publiceren, want de vorige snapshot gebruikte ze nog. De API antwoordt 409 zolang een ander item een asset gebruikt: het script aanvaardt dat en laat dat asset staan. Elke andere fout stopt het. Als laatste print het de id van het nieuwe asset.
# A YouTube item has no asset_id, and two items can share an asset.
older_asset_ids = {item["asset_id"] for item in older_items if item["asset_id"]}
for older_asset_id in older_asset_ids:
response = requests.delete(
f"https://www.gibeon.io/v1/assets/{older_asset_id}",
headers=headers,
timeout=30,
)
# A 409 means another item still uses the asset, so it stays.
if response.status_code != 409:
response.raise_for_status()
print(asset_id) 10 Draai het elke vijf minuten
Cron leest je terminal niet, dus de variabelen staan in de crontab. Vervang /PATH/TO/PROJECT door de map met gibeon.py, .venv en het tokenbestand:
GIBEON_CLIENT_ID=CLIENT_ID GIBEON_REFRESH_TOKEN_FILE=./gibeon-refresh-token GIBEON_PLAYLIST_ID=PLAYLIST_ID GIBEON_PLAYER_ID=PLAYER_ID */5 * * * * cd /PATH/TO/PROJECT && flock -n gibeon.lock .venv/bin/python gibeon.py >> gibeon.log 2>&1
flock -n slaat een run over zolang de vorige bezig is, zodat twee runs niet om het tokenbestand kunnen racen. Het slot is een apart bestand, want het script hernoemt het tokenbestand.
Een access token verloopt na 60 minuten. Elke run vernieuwt eerst en bewaart het nieuwe refresh token, dus het script blijft voorbij die 60 minuten draaien.
De uitvoer en de fouten van elke run komen in gibeon.log.