- Status En cours de résolution
- Percent Complete
- Task Type Autre
- Category Freebox OS → API
-
Assigned To
rfliedel - Operating System Freebox Server V7 (Delta)
- Severity Low
- Priority Very Low
- Reported Version 4.1.5
- Due in Version Undecided
-
Due Date
Undecided
- Votes 4
- Private
Attached to Project: Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)
Opened by spoul - 04/02/2020
Opened by spoul - 04/02/2020
FS#29900 - Utilisation des api
Bonjour,
j’explore actuellement l’utilisation des api freebox, je constate que la doc n’est pas à jours, il y est fait mention de la v5 des api, quand je fait une requete mDNS je constate que les api sont en fait en V7.
Il est fait mention de websocket dans cette doc, il n’est pas fait mention de l’url pour les utiliser, et de fait j’ai essayer tout ce qu’il me passait par la tête et rien n’a fonctionner.
Ma demande consiste donc a avoir la doc à jour, et dans l’intervalle je ne serais pas contre un p’tit exemple d’utilisation des websockets ou au moins l’url du endpoint.
Loading...
Available keyboard shortcuts
- Alt + ⇧ Shift + l Login Dialog / Logout
- Alt + ⇧ Shift + a Add new task
- Alt + ⇧ Shift + m My searches
- Alt + ⇧ Shift + t focus taskid search
Tasklist
- o open selected task
- j move cursor down
- k move cursor up
Task Details
- n Next task
- p Previous task
- Alt + ⇧ Shift + e ↵ Enter Edit this task
- Alt + ⇧ Shift + w watch task
- Alt + ⇧ Shift + y Close Task
Task Editing
- Alt + ⇧ Shift + s save task
Actuellement le SDK n'est pas à jour...
Il faudrait aussi faire une mise à jour de :
- https://dev.freebox.fr/sdk/
- https://dev.freebox.fr/sdk/os/
Bonjour
Avez vous trouvé ?
Cordialement
nbanba
Bonjour
Les websocket ont étés documentés dans l API à partir de la version 8.2
Des exemples supplémentaires dans la doc seraient bienvenus
Avec la doc (je ne suis pas développeur), j ai réussi a faire un script en bash qui utilise les API pour faire les actions suivantes sur les VM:
- shutdown (acpi)
- stop (force)
- start
- restart
- liste / status des VM
- lance la console (avec les websocket api)
Donc si vous cherchez toujours à utiliser les websocket, je peux vous passer et vous expliquer le script. C est très basique mais ca m a permis de comprendre comment ça fonctionne sur la Freebox delta.
Cordialement
nbanba
Bonjour,
Je serai intéressé par votre script pour une connexion en websocket @nbanba.
Pouvez-vous me partager le code ?
Cordialement
Bonjour
@Starli0n : vous trouverez le code ici :
https://github.com/nbanb https://github.com/nbanb
Les projets les plus intéressants sont :
la librairy : fbx-delta-nba_bash_api.sh
le programme de contrôle des VM : fbxvm-ctrl
Le programme ne fonctionne pas sans la librairy. Il faut aussi télécharger le binaire (ou build les sources) du client websocat, les instructions sont dans le changelog de la librairy.
Mais si vous voulez, j'ai déjà build 2 versions de websocat (arm64 et amd64) incluant une fonction qui n'est pas dans la main branche du dépot github de websocat et permettant de gérér l'interruption de la session quand le terminal (stty) est en mode "raw" sans utiliser de programmes externes comme "dtach" ou "screen" (Vitaly Shukela le développeur de websocat à release cette fonction pour le use case précis de l'accès à la console des VM Freebox).
Je peux vous fournir les binaires compilés ou le code et la procédure pour build (c'est du RUST)
Il y a d'autres projets dans le dépot GitHub (fbx-reboot, fbxvm-status) mais ils sont beaucoup moins avancés que le programme fbxvm-ctrl.
Je n'ai pas eu trop de temps cet été, mais je maintiendrai ces dépots GitHub tant que j'aurais une Freebox Delta et j'apporterai au fur et à mesure d'autres fonctionnalités
Voici l'help du script fbxvm-ctrl :
N'hésitez pas à me solliciter si vous avez besoin d'aide
Cordialement
nbanba
Thank you @nbanba for your help
I am coding in Python and I trying to initiate a websocket connection to replace an API call.
Concretely, I want to check the lan connections activity on my freebox in websocket instead of api
ie: https://dev.freebox.fr/sdk/os/lan/#lan-browser
but I am not sure it is even possible, even though the documentation implies that it is possible:
https://dev.freebox.fr/sdk/os/# (WebSocket API)
Dear Starli0n
After publishong the new version of the library you can find here:
https://https://github.com/nbanb/fbx-delta-nba_bash_api.sh
I've found someone which did exactly what you need and what you wanted to do, but in BASH and not in python:
(Monitoring webwocket register event on
The project is here : https://github.com/Matsuo3rd/freebox-lan-monitor/blob/main/freebox-lan-monitor.sh
It is simple to use the library https://https://github.com/nbanb/fbx-delta-nba_bash_api.sh for all other functions which manage the API login, token, etc… than the noticed project but the monitor function with websocat is the one you search:
Kind regards
nbanba