Il est prévu de piloter la cafetière via internet. Pour cela, il faut une API. Heureusement, la RFC 2324 existe et va nous faciliter le travail ! Cette RFC (un standard, donc) présente le modèle d'une API pour piloter une cafetière en ligne. Malheureusement, cette RFC est assez sommaire, et il va nous falloir boucher les trous.

Si des implémentations de la partie client de cette RFC 2324 existent déjà (pour EMACS, par exemple), à ma connaissance ça sera la première implémentation au monde de la partie serveur. W00t, comment ça le fait :)

L'API est construite progressivement sur le wiki.

URI

En accord avec la RFC 2324, l'URI de la cafetière est quelque chose comme « café://$serveur/$machine » où :

  • serveur : « LaboLyon.fr » en IPv6 bien sur !
  • machine : « cafetière »

Opérations réalisables

  1. obtenir l'état global de la cafetière
  2. obtenir l'âge du café
  3. obtenir le niveau du café
  4. obtenir la température du café
  5. lancer le café
  6. faire chauffer le café
  7. arrêter la chauffe du café

Obtenir l'état global de la cafetière

  • Méthode : GET
  • Résultat :
    • OK
      • code : 200
      • Safe : yes
      • XML (text/xml) de l'état
    • Cafetière indisponible
      • code : 404
      • Safe : yes
      • XML (text/xml) de la dernière présence connue
    • Cafetière supprimée
      • code : 410
      • Safe : yes
    • Microcontrôleur pas opérationnel
      • code : 503
      • Safe : yes
      • XML (text/xml) du dernier état opérationnel connu
    • Serveur en rade
      • code : 500
      • Safe : yes

TODO

  • étendre la RFC 2324 avec authentification → s'appuyer sur HTTP ?
  • étendre la RFC 2324 avec chiffrement → s'appuyer sur SSL ?

Références