MicroPython-I2C

Introduction

Voila, je me suis mis en tête de supporter quelques breakout I2C d'Adafruit sur la PyBoard. C'est un projet intéressant et captivant.

Cet article reprends différentes notes utilises à ce sujet.

Revoir la définition des finitions https://docs.micropython.org/en/latest/library/machine.I2C.html

Bus I2C en quelques mots

I2C est la contraction de "Inter Integrated Circuit".

Ce dernier permet d'établir des connexions asynchrones entre plusieurs composants intelligents pour partager des informations via un "bus commun".

Si ce bus est utilisé pour permettre à un microcontroleur (PyBoard,Arduino,Raspberry-Pi) de communiquer avec des senseurs (un réseau de senseur), il permet aussi à des microcontrôleurs de communiquer directement ensembles.

• PyBoard dispose d'une class pour I2C, ce qui rend la mise en oeuvre très facile.
• Principalement développé pour la Domotique et l'électronique domestique, ce bus est très populaire et donc utilisé par de nombreux composants. Les PC, lecteurs DVD, télévisions, etc disposent généralement d'un tel bus.
• Le protocole I2C ne requière que 3 fils pour fonctionner et peut être implémenté sur n'importe quel microcontrôleur.
• La longueur du bus est de l'ordre de 1 mètre... mais il est possible de l'étendre jusqu'à 30 mètres à l'aide d'un simple composant nommé "I2C extender".
• Il dispose d'un mécanisme d'adressage à la fois simple et efficace permettant à plusieurs senseurs de fonctionner sur un seul bus.
• Supporte plusieurs maître (Attention: dans ce cas il y a donc risque de collisions).

Quelques documents sur le net:

• Document Inter Integrated Circuit sur Wikipédia (fr)
  Incluant des informations sur le protocole de communication I2C.
• Autre article sur Inter Integrated Circuit paru sur Aurel32.net (très bonne référence)
  Aborde le processus d'adressage dans son ensemble et présente également quelques circuit utilisant le protocole I2C.

Les concepts associés au bus I2C

Il y a quelques concepts de base à maîtriser autour de l'I2C:

• Le concept de "maître et esclave"
• Le principe d'adressage (adresse unique pour chaque esclave).
• Le concept de régulation de communication comme "Master Reader" et "Master Writer"

Nous avons rédigé une page d'explication autour du Bus I2C d'Arduino... mais un bus I2C reste avant tout un bus I2C, qu'il soit sur Arduino, PyBoard, Raspberry-Pi, ...

Nous ne saurions que trop vous recommander de parcourir cette page pour vous familiariser avec ces concepts.

Principes I2C

Comprendre les principes fondamentaux du bus I2C.

Cliquez ici

 

Les Bus I2C de la PyBoard

Pour Rappel, les signaux sont:

• SDA - Signal DATA (donnée) du bus I2C.
• SCL - Signal CLOCK (horloge) du bus I2C.

Tolérance 5V

Petit rappel, toutes les broches du PyBoard sont tolérantes à 5V sauf PA4 & PA5 (dixit PYBv10b.pdf)

Par conséquent, le bus SPI du skin X n'est pas tolérant à 5 Volts.

La classe I2C

I2C est un protocole de communication 2-fils permettant à des périphérique de communiquer ensembles.

Sur le plan physique, cela consiste en deux fils: SCL et SDA, la ligne d'horloge (SCL) et ligne de donnée (SDA).

Les objets I2C sont créés en étant rattaché spécifiquement sur un bus matériel (en précisant son ID) -OU- sur un bus émulé de façon logiciel (en précisant les 2 broches sda et scl de façon arbitraire).

Le bus peut être initialisé à la création de l'objet --ou-- initialisé plus tard:

Voici quelques exemples:

from machine import I2C

i2c = I2C(1)                         # créé sur le bus 1 de la Pyboard
i2c = I2C( sda=Pin(2), scl=Pin(4) )  # créé sur 2 broches arbitraire d'un l'ESP8266-EVB

# scanne les esclaves disponibles et retourne une list d'adresses 7-bits
i2c.scan()                      

# Ecrire 3 octets vers l'esclave à l'adresse 42 (adresse 7-bits)
i2c.writeto(42, b'123')         

# Lire 4 octets depuis l'esclave à l'adresse 42
i2c.readfrom(42, 4)

# Lire 3 octets à partir de l'adresse mémoire (registre) 8 
# de l'esclave (esclave à l'adresse 42).
i2c.readfrom_mem(42, 8, 3)    

# écrire 1 octet (\x10) à l'adresse mémoire (registre) 2
# de l'esclave (esclave à l'adresse 42)
i2c.writeto_mem(42, 2, b'\x10')

Afficher l'objet i2c vous permet d'avoir des informations à propos de sa configuration.

Constructeur

class machine.I2C(id=-1, *, scl, sda, freq=400000)

Crée et retourne un nouvel objet I2C en utilisant les paramètres suivants:

• id identifie un périphérique en particulier. La valeur par défaut -1 sélectionne l'implémentation logiciel du bus I2C (BitBang I2C) sur deux broches SDA, SCL arbitraires (fonctionne généralement avec toutes les broches). Les autres valeurs utilisable pour id dépend de l'implémentation des ports sur la carte (dans ce cas, il n'est pas nécessaire de spécifier les paramètres scl et sda).
• scl doit être un objet Pin spécifiant la broche à utiliser pour SCL (signal d'horloge I2C).
• sda doit être un objet Pin spécifiant la broche à utiliser pour SDA (signal de donnée).
• freq est un entier fixant la vitesse maximale du bus (400000 pour 400 KHz).

Sans paramètre additionnel, l'objet I2C est créé mais pas initialisé (il dispose des paramètres de la dernière initialisation du bus, s'il cela est applicable).

Si des paramètres complémentaires sont fourni alors le bus est initialisé. Voyez la méthode init pour les paramètres d'initialisation.

Les broches physique du bus I2C sont:

• I2C(1) sur la partie X de la carte: (SCL, SDA) = (X9, X10) = (PB6, PB7)
• I2C(2) sur la partie Y de la carte: (SCL, SDA) = (Y9, Y10) = (PB10, PB11)

Méthodes générales

i2c.deinit()

Désactive le bus I2C (WiPy).

i2c.init(...)

i2c.init(scl, sda, *, freq=400000)

Initialise le bus I2C avec les paramètres suivants:

• scl : ligne du signal d'horloge SCL du bus I2C, un objet Pin
• sda : ligne du signal de donnée SDA du bus I2C, un objet Pin
• freq : la fréquence du signal d'horloge sur le bus I2C.

i2c.scan()

Scanne toutes les adresses du Bus I2C de 0x01 à 0x7f et retourne une liste Python des adresses offrant une réponse.

A noter que certains composant (comme le AM2315) n'offrent pas de réponse et ne sont donc pas détectable par cette méthode.

Hormis ce détail, il s'agit d'une méthode fiable car la plupart des composants répondent.

Méthodes Primitives

Les méthodes suivantes implémentes les primitives pour les opérations maîtres sur le bus I2C et peut être combiné avec n'importe quelle transaction I2C.

Ces fonctions sont mises à disposition si vous avez besoin de contrôler précisément le bus SINON voyez les méthodes standard d'accès au bus I2C (voir ci-dessous).

Ces méthodes ne sont disponibles que pour les bus I2C logiciels.

Le protocole I2C prévoit des conditions de départ (START) et d'arrêt (STOP) qui signal l'envoi d'une nouvelle trame de donnée sur le bus.

Ces conditions correspondent à des niveaux particuliers des signaux SDA et SCL.

Condition START:
correspond au passage du signal SDA du niveau HAUT vers BAS pendant que le signal SCL reste au niveau haut.

Condition STOP:
correspond au passage du signal SDA du niveau BAS vers HAUT pendant que le signal SCL reste au niveau haut.

i2c.start()

Génère une condition de démarrage/début de transaction (START) sur le bus.

Le signal SDA passe au niveau bas pendant que SCL est au niveau haut.

i2c.stop()

Génère une condition d'arrêt (STOP) sur le bus I2C.

Le signal SDA passe au niveau haut pendant que SCL est au niveau haut.

i2c.is_ready(...)

i2c.is_ready(addr)

Vérifie si un périphérique I2C répond sur l'adresse donnée. Uniquement valide pour le mode master.

i2c.meminto(...)

i2c.readinto(buf, nack=True)

Lit des octets depuis le bus, données stockées dans la mémoire tempon buff. Un ACK sera envoyé sur le bus à la réception de chaque octets (sauf le dernier). Lorsque le dernier octet est réceptionné, si nack iest True alors un NACK sera envoyé, sinon ACK sera envoyé (dans ce cas, l'esclave sait que d'autres octets seront lus lors d'un prochain appel).

i2c.write(...)

i2c.write( buf )

Envoi les octets disponibles dans buf sur le bus I2C. Vérifie qu'un ACK est reçu après chaque octet. Cesse la transmission des derniers octets si un NACK est réçu en réponse. La fonction retourne ne nombre d' ACK reçu.

Opérations standard du bus

Les méthodes suivantes implémente les opérations standard du Maître (Leader) du bus I2C. Cela concerne les opération de lecture (read) et d'écriture (write) à destination d'un périphérique Esclave (Suiveur).

I2C.readfrom(...)

i2c.readfrom(addr, nbytes, stop=True)

Lecture de nbytes octets depuis l'esclave identifié par son adresses addr. Si le paramètre stop est True alors la condition d'arrêt (STOP) est générée à la fin du transfert.

Retourne un objet bytes avec les données lue sur le bus.

• addr est l'adresse du périphérique I2C.
• nbytes le nombre d'octets à lire.
• stop placer une condition d'arrêt en fin de transation.

I2C.readfrom_into(...)

i2c.readfrom_into(addr, buf, stop=True)

Lit des données depuis l'esclave à l'adresse addr et stocke les données dans la mémoire tampon buf. Le nombre d'octets lus sur le bus correspond à la taille de buf.

Si le paramètre stop est True alors la condition d'arrêt (STOP) est généré à la fin du transfert I2C.

La méthode retourne None.

• addr l'adresse de l'esclaver depuis lequel les données seront réceptionnées.
• buf la mémoire tampon (type bytes) dans lequel les donnéees seront écrite. La taille de buf détermine le nombre d'octets lu sur le bus.
• stop indique s'il faut générer une condition d'arrêt sur le bus après réception des données.

I2C.writeto(...)

i2c.writeto(addr, buf, stop=True)

Ecrit les octets présents le paramètre buf (objet de type bytes vers l'esclave mentionné dans le paramètre addr.

Si un NACK est récu suite à l'écriture d'un octet de buf alors le restant des octets n'est pas envoyé sur le bus.

Si stop est True alors la condition d'arrêt (STOP) est généré à la fin du transfert, même si un NACK est recu durant le transfert.

La fonction retourne ne nombre de ACK réceptionné durant le transfert.

• addr l'adresse vers laquelle les données seront envoyées.
• buf la mémoire tampon (type bytes) depuis lequel les données seront lue. La taille de buf détermine le nombre d'octets envoyé sur le bus.
• stop indique s'il faut générer une condition d'arrêt sur le bus après réception des données.

Opérations mémoire

Certains périphériques I2C fonctionnent comme des mémoires (ou ensemble de registres) qu'il est possible de lire ou dans lesquels il est possible d'écrire.

Dans ce cas, il y a deux adresses associées avec le périphérique I2C:

• Une adresses esclave I2C
• Une adresse mémoire.

Les méthodes suivantes sont concçue pour communiquer avec de les périphériques.

I2C.readfrom_mem(...)

I2C.readfrom_mem(addr, memaddr, nbytes, *, addrsize=8)

Lecture de nbytes octets depuis l'esclave indiqué à l'adresse addr starting from the memory address specified by memaddr.

L'argument addrsize permet de spécifié le nombre de bits d'adresse.

Retourne un objet de type bytes avec les données lue sur le bus.

I2C.readfrom_mem_into(...)

i2c.readfrom_mem_into(addr, memaddr, buf, *, addrsize=8)

Lit des octets depuis un esclave accessible à l'adresse addr en débutant la lecture à l'adresse memaddr et stocke les octets dans la mémoire tampon buf.

Le nombre d'octers lu correspond à la taille de mémoire tampon buf (objet de type bytes.

L'argument addrsize spécifie la taille de l'adresse (en bits). Sur un ESP8266, cet argument n'est pas reconnu et la taille de l'adresse est toujours de 8 bits.

La méthode retourne None.

I2C.writeto_mem(...)

i2c.writeto_mem(addr, memaddr, buf, *, addrsize=8)

Ecrit le contenu de buf (un objet de type bytes) vers l'esclave identifié par l'adresse addr en débutant à l'adresse mémoire indiquée par l'argument memaddr.

L'argument addrsize mentionne la taille de l'adresse en bit (sur ESP8266 cet argument n'est pas reconnu et l'adresse est toujours en 8 bits).

La méthode retourne None.

Constantes

• I2C.MASTER - pour l'initialisation du bus en mode master (maître).
• I2C.SLAVE - pour l'initialisation du bus en mode slave (esclave).

---

Source: class I2C écrit par/written by Damien P.George et autres sources.

Traduit/composé par Meurisse D. pour MCHobby.be - Translated/assembled by Meurisse D. for MCHobby.be

Traduit avec l'autorisation de micropython.org - Translated with the authorisation of micropython.org

Toute référence, mention ou extrait de cette traduction doit être explicitement accompagné du texte suivant : «  Traduction par MCHobby (www.MCHobby.be) - Vente de kit et composants » avec un lien vers la source (donc cette page) et ce quelque soit le média utilisé.

L'utilisation commercial de la traduction (texte) et/ou réalisation, même partielle, pourrait être soumis à redevance. Dans tous les cas de figures, vous devez également obtenir l'accord du(des) détenteur initial des droits. Celui de MC Hobby s'arrêtant au travail de traduction proprement dit.