RainFbx est un plugin pour Rainmeter, utilisant des mesures récupérées au travers de l'API de la Freebox du fournisseur d'accès Free.
Téléchargez la dernière release correspondante à votre version de Rainmeter (32 ou 64 bits), et copiez le fichier dll dans le repertoire "Plugins" de votre installation Rainmeter (par défaut: C:\Program Files\Rainmeter\Plugins).
Lors du premier lancement, il est conseillé d'utiliser le skin "illustro - Freebox Status & Bandwidth" pour faciliter l'étape d'autorisation.
Le plugin nécessite d'être autorisé via la facade de la Freebox lors du premier lancement. L'utilisation des mesures RRD nécessite également l'ajout des permissions spécifiques au travers de l'interface FreeboxOS via "Paramètres de la Freebox > Gestion des accès > Applications > Editer > Modifications des réglages de la Freebox"
Pour récupérer d'autres mesures de la Freebox et/ou pour intégrer d'autres skins, vous pouvez vous inspirez des skins fournis en exemple, ou lire le détails des variables disponibles ci-dessous.
La configuration du plugin nécessite au moins 2 sections au sein de votre fichier de configuration :
La section "Configuration de la Freebox" est généralement unique au sein de la configuration du skin (sauf à vouloir intégrer les mesures de plusieurs Freebox au sein d'un même skin).
Exemple :
[FreeboxConfig]
Measure=Plugin
Plugin=RainFbx.dll
Hostname="http://mafreebox.freebox.fr/"
AppToken=grEGErgeERG09ergRGE9greGREgkgrelgremgErgergEgezkafmlekvxemlsvkZl
#####Measure / Plugin##### Obligatoires
Les variables Measure et Plugin sont obligatoires, et doivent être fixées aux valeurs exemple pour indiquer quel plugin utiliser.
#####Hostname##### Optionnelle, valeur par défault = "http://mafreebox.freebox.fr/"
Utilisez cette variable pour indiquer une url vers l'API de votre freebox différente de l'URL locale par défaut (pour utiliser une API distante par exemple).
#####AppToken##### Optionnelle, pas de valeur par défaut, mais renseignée automatiquement.
Cette variable sera ajoutée et renseignée automatiquement lors de la première autorisation du plugin auprès de la Freebox. Renseignez là préalablement si vous la connaissez (lors de la duplication d'un skin par exemple).
Il peut exister plusieurs sections "Configuration de Mesure" au sein d'un même fichier de configuration de skin.
Exemple :
[FbxMesureConfig]
Measure=Plugin
Plugin=RainFbx.dll
FbxAPIConf=freeboxConfig
MeasureDb=composite
MeasureField=busy_up
#####Measure / Plugin##### Obligatoires
Les variables Measure et Plugin sont obligatoires, et doivent être fixées aux valeurs exemple pour indiquer quel plugin utiliser.
#####FbxAPIConf##### Obligatoire, pas de valeur par défaut
Cette variable doit indiquer vers quelle section "Configuration de la Freebox" cette section dépend.
#####MeasureDb##### Obligatoire, pas de valeur par défaut
Cette variable indique au sein de quelle database la mesure appartient. La liste des databases est disponible sur le site de Freebox API.
La valeur composite a été ajoutée au sein de ce plugin pour regrouper les mesures personalisées.
#####MeasureField##### Obligatoire, pas de valeur par défaut
Cette variable indique le nom de la mesure. La liste des mesures est disponible sur le site de Freebox API.
Les mesures suivantes personnalisées ont été ajoutées à la database "composite" :
- status : Renvoie (via GetString) le status courant du plugin.
- busy_down : Renvoie le pourcentage d'occupation de la bande passante montante (download)
- busy_up : Renvoie le pourcentage d'occupation de la bande passante descendante (upload)
Le projet se compile en l'état sous Visual Studio 2015. Seule la librairie C++ REST SDK doit être compilée statiquement (car trop lourde) à partir des sources en suivante le guide How to statically link the C++ REST SDK (Casablanca) et placée dans le repertoire lib/ correspondant.