INF1007 - Simulateur de décodeurs

Manuel d'utilisation

Pour votre travail de session, votre application devra pouvoir communiquer avec des décodeurs pour certaines de ses fonctionnalités. Vous devrez donc utiliser ce simulateur de décodeurs pour démontrer le bon fonctionnement de votre application. Ce document décrit le fonctionnement du simulateur ainsi que des exemples de requête pour effectuer les différentes opérations supportées.

Points d'accès

Le simulateur est un API REST disponible à partir du site Web https://wflageol-uqtr.net .

Deux services sont mis à votre disposition :

• https://wflageol-uqtr.net/decoder : L’API REST permettant de communiquer avec les différents décodeurs.
• https://wflageol-uqtr.net/list : Une page HTML permettant de consulter l’état de vos décodeurs.

API Decoder

Pour communiquer avec un décodeur, vous devez envoyer une requête POST au point d’accès https://wflageol-uqtr.net/decoder. Voici un exemple de code en C# qui envoie la commande « info » :

using System.Net.Http.Headers;
using System.Text.Json;

var client = new HttpClient();

client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

var postDataValues = new
{
    // Remplacez par votre code permanent.
    id = "AAAA00000000",
    address = "127.0.10.1",
    action = "info"
};
var postData = new StringContent(JsonSerializer.Serialize(postDataValues));

// Ici les méthodes async sont exécutées de façon synchrone en appelant .Result après
// chaque appel.
var response = client.PostAsync("https://wflageol-uqtr.net/decoder", postData).Result;
if(response.IsSuccessStatusCode)
{
    var stringData = response.Content.ReadAsStringAsync().Result;
    Console.WriteLine(stringData);
} else
{
    Console.WriteLine($"{(int)response.StatusCode} {response.ReasonPhrase}");
}

Le service doit recevoir un objet JSON avec les champs suivants :

• id : Votre code permanent.
• address : L’adresse IP du décodeur. Vos décodeurs ont une plage de 127.0.10.1 à 127.0.10.12.
• action : L’opération que vous voulez effectuer. Il y a quatre opérations valides :
  • reset : Redémarre le décodeur. Chaque décodeur prend entre 10 à 30 secondes à redémarrer.
  • reinit : Réinitialise le mot de passe du décodeur. Pour les besoins du simulateur, cela met simplement à jour la date de réinitialisation.
  • shutdown : Éteint le décodeur. Pour les besoins du simulateur, on peut toujours redémarrer le décodeur par la suite avec l’opération « reset ».
  • info : Retourne l’état du décodeur.

Pour chaque action, le service retournera un objet JSON avec l’information contenant les champs suivants :

• response : « OK » si l’opération a réussi, « Error » sinon.
• message : Seulement en cas d’erreur. Contient le message d’erreur.

Les champs suivants sont disponibles seulement pour l’opération « info » :

• state : « Active » ou « Inactive » dépendamment de si le décodeur est en fonction ou éteint.
• lastRestart : Date et heure du dernier redémarrage.
• lastReinit : Date et heure de la dernière réinitialisation du mot de passe.

Liste des décodeurs

Pour vous aider, le simulateur contient aussi une page permettant d’afficher la liste de vos décodeurs. Il s’agit d’une page HTML ordinaire que vous pouvez accéder à partir de votre navigateur : https://wflageol-uqtr.net/list?id=AAAA00000000

Remplacez AAAA00000000 par votre code permanent pour accéder à vos décodeurs.