REST/HTTP API

Limelight OS מציג שרת REST/HTTP הפועל בכתובת (ipaddress):5807

LimelightLib Python היא ספריית קוד פתוח המשתמשת ב-Limelight HTTP/REST API.

הערה: לדוגמה http://(limelight-ip-address):5807/results

כללי

שיטה	נתיב	תיאור
GET	/results	קבלת פלט JSON מלא של תוצאות המיקוד הנוכחיות
GET	/status	קבלת אובייקט סטטוס JSON עם טמפרטורה, fps, שם המכשיר, אינדקס צינור, שימוש במעבד, שימוש בזיכרון
GET	/hwreport	מחזיר מערך JSON של דוחות חומרה מלאים. דוח חומרה מכיל מידע קריא לאדם כגון FOV, היסט עיקרי וכו'

ניהול צינורות (Pipelines)

שיטה	נתיב	תיאור
GET	/pipeline-default	קבלת צינור ברירת מחדל (JSON)
GET	/pipeline-atindex	קבלת pipeline[n] מהמצלמה (JSON). טוען צינור מהדיסק. יש לכלול פרמטר 'index' בבקשה.
POST	/pipeline-switch	מעבר לצינור אחר. יש לכלול פרמטר 'index' בבקשה.
POST	/reload-pipeline	אילוץ המצלמה לטעון מחדש את הצינור הנוכחי ואת כל משאבי הצינור
POST	/update-pipeline	מקבל JSON עם עדכון אחד או יותר להגדרות. הגדר פרמטר url "flush" ל-1 כדי לשמור הגדרות אלה לדיסק.
POST	/upload-pipeline	העלאת צינור. שלח נתוני JSON בגוף הבקשה. אופציונלית כלול פרמטר 'index'. דורס צינור בדיסק

ניהול מצלמה

שיטה	נתיב	תיאור
POST	/set-imumode	הגדרת מצב IMU (JSON)
POST	/set-throttle	הגדרת מספר הפריימים לדלג בין פריימים מעובדים לניהול תרמי
POST	/set-imuassistalpha	הגדרת אלפא של פילטר משלים במצב IMU Assist (ברירת מחדל 0.001)

ניהול משאבים

שיטה	נתיב	תיאור
POST	/upload-fieldmap	העלאת מפת שדה. שלח נתוני JSON בגוף הבקשה. אופציונלית כלול פרמטר 'index'.
POST	/upload-python	העלאת קוד פייתון. שלח את הקוד כטקסט רגיל בגוף הבקשה. אופציונלית כלול פרמטר 'index'.
POST	/upload-nn	העלאת רשת נוירונים. כלול פרמטר 'type' ("detector" או "classifier"), תוכן הקובץ בגוף הבקשה, ואופציונלית כלול פרמטר 'index'.
POST	/upload-nnlabels	העלאת תוויות רשת נוירונים. כלול פרמטר 'type' ("detector" או "classifier"), הקובץ בגוף הבקשה, ואופציונלית כלול פרמטר 'index'.
GET	/getsnapscriptnames	רשימת שמות snapscriptpro

פייתון וכיוון רובוט

שיטה	נתיב	תיאור
POST	/update-pythoninputs	עדכון קלטי פייתון עבור צינורות SnapScript. שלח נתוני JSON (מערך) בגוף הבקשה.
POST	/update-robotorientation	עדכון כיוון הרובוט. שלח נתוני JSON (מערך) בגוף הבקשה. לדוגמה "[45,0,0,0,0,0]". שימוש בשיטה זו מבטל עדכוני כיוון מבוססי NetworkTables עד להפעלה מחדש/אתחול

כיול

שיטה	נתיב	תיאור
GET	/cal-default	מחזיר תוצאת כיול ברירת מחדל
GET	/cal-file	מחזיר תוצאת כיול מותאמת אישית (מערכת קבצים)
GET	/cal-eeprom	מחזיר תוצאת כיול מותאמת אישית (eeprom)
GET	/cal-latest	מחזיר את תוצאת הכיול המותאמת האחרונה. תוצאה זו אינה בשימוש אלא אם היא נשמרת למערכת הקבצים או ל-eeprom
POST	/cal-eeprom	עדכון תוצאת כיול ה-eeprom. שלח נתוני כיול בגוף הבקשה.
POST	/cal-file	עדכון תוצאת כיול מערכת הקבצים. שלח נתוני כיול בגוף הבקשה.
DELETE	/cal-latest	מחיקת תוצאת הכיול האחרונה
DELETE	/cal-eeprom	מחיקת תוצאת כיול ה-eeprom
DELETE	/cal-file	מחיקת תוצאת כיול מערכת הקבצים

תמונות מצב (Snapshots)

שיטה	נתיב	תיאור
POST	/capture-snapshot	צילום תמונת מצב. כלול פרמטר url 'snapname' כדי לתת שם לתמונת המצב.
POST	/upload-snapshot	העלאת תמונת מצב בעלת שם. כלול פרמטר url 'snapname' וקובץ תמונה בגוף הבקשה.
GET	/snapshotmanifest	מחזיר רשימה של שמות קבצי תמונות מצב
DELETE	/delete-snapshots	מוחק את כל תמונות המצב
DELETE	/delete-snapshot	מחיקת תמונת מצב ספציפית. כלול פרמטר 'snapname' בבקשה.