API UCUq

API de UCUq #

IMPORTANT (vraiment) : les différentes méthodes ci-dessous ne sont exécutées par le microcontrôleur que lors d’un appel à ucuq.commit().

Classe GPIO #

Gestion d’une sortie correspondant à une broche du microcontrôleur.

  • GPIO(<pin>) (constructeur) : retourne un objet gérant la broche identifiée par <pin> ;
  • high() : met la broche à l’état haut ;
  • low() : met la broche à l’état bas.

Classe WS2812 #

Gestion de DELs de type WS2812.

  • WS2812(<pin>,<count>) (constructeur) : retourne un objet gérant <count> DELs WS2812 connectées à la broche <pin> ;
  • setValue(<index>, <value>) : met dans le tampon la DEL d’index <index> (débutant à 0) à la couleur <value> (au format [R,G,B] de 0 à 255) ;
  • fill(<value>) : met dans le tampon toutes les DELs à la couleur <value> ;
  • write() : envoie le contenu du tampon aux DELs.

Classe I2C #

Gestion du protocole I2C.

  • I2C(<sda>,<scl>) (constructeur) : retourne un objet gérant un composant connecté aux broches du microcontrôleur identifiées par <sda> et <scl> et prenant en charge le protocole I2C.

Classe SoftI2C #

Même chose que la classe I2C, mais géré par logiciel, <sda> et <scl> pouvant ainsi être n’importe quelle broche GPIO du microcontrôleur.

Classe HT16K33 #

Gestion d’un composant de type HT16K33.

  • HT16K33(<i2c>) (constructeur) : retourne un objet gérant un composant HT16K33 au travers de <i2c> qui doit être une instance de I2C ou SoftI2C ;
  • setBlinkRate(<rate>) : définit comme <rate> le nombre de fois par seconde que l’affichage clignote (valeurs autorisée : 0, 0.5, 1 et 2) ;
  • setBrightness(<brightness>) : définit <brightness> comme intensité lumineuse de l’afficheur (de 0 et 15) ;
  • clear() : vide le tampon de l’afficheur ;
  • draw(<motif>) : met dans le tampon de l’afficheur <motif>, qui doit une séquence de caractères hexadécimaux représentant chacun 4 pixels ;
  • plot(<x>,<y>,<ink>) : allume si <ink> est à 1 ou éteint si <ink> est à 0 le pixel à la position <x>, <y> dans le tampon de l’afficheur ;
  • show() : envoie le contenu du tampon à l’afficheur.

Classe PWM #

Gestion d’une sortie de type PWM.

  • PWM(<pin>,<freq>,*,ns=<ns>,u16=<u16>) (constructeur) : retourne un objet générant un signal sur une sortie de type PWM identifiée par <pin> d’une fréquence de <freq> Hz et avec une largeur d’impulsion de <ns> nanosecondes ou d’un ratio de <u16> / 65536 (<ns> et <u16> ne peuvent pas être définis simultanément) ;
  • setU16(<u16>) : génère un signal avec une largeur d’impulsion d’un ratio de <u16> / 65536 ;
  • setNS(<ns>) : génère un signal avec une largeur d’impulsion de <ns> nanosecondes ;
  • setFreq(<freq>) : génère un signal d’une fréquence de <freq> Hz.

Classe LCD_PCF8574 #

Gère un afficheur LCD basé sur un composant de type PCF8574.

  • LCD_PCF8574(<i2c>,<lines>,<columns>) (constructeur) : retourne un objet gérant, au travers de <i2c> qui doit être une instance de I2C ou de SoftI2C, un composant de type PCF8574 connecté à un afficheur LCD de <lines> lignes et <columns> colonnes ;
  • moveTo(x,y) : positionne le curseur à la ligne <x> et la colonne <y> ;
  • putString(<string>) : affiche la chaîne de caractères <string> ;
  • clear() : efface l’afficheur ;
  • hideCursor() : cache le curseur ;
  • showCursor() : affiche le curseur ;
  • blinkCursorOff() : désactive le clignotement du curseur ;
  • blinkCursorOn() : active le clignotement du curseur ;
  • backlightOff() : désactive le rétro-éclairage ;
  • backlightOn() : active le rétro-éclairage.

Classe SSD1206_I2C #

Gère un écran OLED via le protocole I2C.

  • SSD1206_I2C(<width>,<height>,<i2c>) : retourne un objet gérant un écran OLED de dimensions <width> par <height> au travers de <i2c>, qui doit être une instance de I2C ou de SoftI2C ;
  • fill(<col>) : remplit le tampon de la couleur <col> ;
  • pixel(<x>,<y>,<col>) : met le pixel à la position <x>, <y> dans le tampon à la couleur <col> ;
  • scroll(<dx>,<dy>) : déplace le motif dans le tampon de <dx>, <dy> pixels ;
  • text(<text>,<x>,<y>) : place la chaîne de caractères <text> dans le tampon à la position <x>, <y> ;
  • rect(<x>,<y>,<w>,<h>,fill=<fill> : place un rectangle de largeur <w> et de hauteur <h> à la position <x>, <y> dans le tampon et le remplit si <fill> et à True (valeur par défaut) ;
  • show() : envoie le contenu du tampon à l’afficheur.