Référence : Langage Arduino : [ Mini | Standard | Etendue | Maxi ] Librairies : [ Vue d'ensemble | Synthèse ] Infos : [ Comparaison | Changements ]

La librairie Flash, pour écrire des données en mémoire Flash programme

1.  Description

Cette librairie va permettre de stocker simplement des chaînes de caractères et des constantes en mémoire Flash programme.

Lorsque l'on utilise des constantes ou des chaînes de caractères dans un programme, celles-ci sont stockées en mémoire RAM, mémoire qui est limitée à 2K sur une carte UNO ou Duemilanove. Dès lors que l'on va utiliser beaucoup de chaînes de caractères, cette limitation va poser problème, le programme ayant des comportements inattendus lorsque la RAM est pleine. Pour résoudre ce problème, il est possible de stocker les chaînes de caractères constantes en mémoire Flash programme, d'autant que le plus souvent une bonne partie de celle-ci n'est pas utilisée et est donc disponible.

Cette librairie offre une alternative beaucoup plus simple à mettre en oeuvre que l'utilisation de PROGMEM...

La page d'origine de cette librairie hors référence : http://arduiniana.org/libraries/flash/

2.  Exemples de démonstration

3.  Liste des instructions de la librairie Flash

4.  Descriptif des instructions de la librairie Flash

4.1  Objets Flash

Creating named Flash objects

To create a Flash object, you use a library-provided macro. Each of the four basic types provides its own creation macro:

• Strings: FLASH_STRING(name, value)
• Arrays: FLASH_ARRAY(type, name, list of values…)
• Tables: FLASH_TABLE(type, name, columns, values…)
• String Arrays: FLASH_STRING_ARRAY(name, values…)

Examples:

[Note that you can make Arrays and Tables out of any native type.]

[Note also that the String Array is a slightly special case. For technical reasons, as you can see in the example, each member of the array initializer must be wrapped with the PSTR() operator. For this reason, String Arrays cannot be declared at global scope, but must be non-statically defined within in the body of a function. Note also that while the individual strings in a String Array are contained in PROGMEM space, the array itself (again, for technical reasons) is RAM-based, consuming 2 bytes per array element. This limitation does not apply to the other Flash types.]

Using named Flash objects

Array-like access. Each Flash type provides an [] operator to get access to the underlying data, for example:

Since Tables are really just two-dimensional arrays, the Table object’s implementation of [] returns a one-dimensional Array object.

Size. Each Flash type provides a mechanism for determining its size:

• String and String Array: size_t length();
• Array: size_t count();
• Table: size_t rows(); size_t cols();

4.2  Fonctions disponibles

Access.

If you need it, each Flash object provides an access() method that returns the underlying PROGMEM pointer

Print compatibility. Each Flash object has a print() method that can be used to serialize the object to any stream derived from core class Print (HardwareSerial, NewSoftSerial, LiquidCrystal, Ethernet, PString, etc.) See “Printing Flash objects” below.

String copy.

Flash String objects may be copied in whole or part to RAM using the String object’s copy method:

    // copies the first 10 characters of the big_string
    char temp[11];
    big_string.copy(temp, 10);

Printing Flash objects

Each Flash object can “print” itself, using either its print method directly:

    temperatures.print(Serial);
    big_string.print(lcd);
    font_table.print(newsoftserial);

or, equivalently, by using the << streaming operator:

    Serial << temperatures;
    lcd << big_string;
    newsoftserial << font_table;

Flash objects can also be “printed” using the familiar Serial.print[ln] syntax, but this requires a small patch to the core Print.h file. See “Patching Print.h” below Using unnamed (inline) Flash Strings

One of the most useful features of the Flash library is the capability to print unnamed strings embedded directly within an expression. In other words, if you want to use a ROM string in a print statement, it is not necessary to declare a string variable and print it like this:

    FLASH_STRING(big_string12,
      "'Twas brillig and the slithy toves did gyre and gimble");
    lcd << big_string12;

Instead you can simply use the new built-in F() macro (F for “Flash”) to do the same thing inline:

    lcd << F("'Twas brillig and the slithy toves did gyre and gimble");

And again, you can also use

    lcd.print(F("'Twas brillig and the slithy toves did gyre and gimble"));

to print an inline string, but this requires the patch to Print.h.

4.3  Library Version

You can retrieve the version of the Flash library by inspecting FLASH_LIBRARY_VERSION.

int ver = FLASH_LIBRARY_VERSION;

5.  Principe d'utilisation

5.1  Installation de la librairie

• Télécharger le fichier .zip de la librairie :
  • la librairie Flash sur notre site
  • ou la librairie Flash sur le site de l'auteur
• Le décompresser et coller le répertoire obtenu dans le répertoire "libraries" de votre répertoire Arduino-00xx

• Relancer le logiciel Arduino : le fichier de la librairie doit apparaître dans la liste des libairies accessibles depuis le menu

La librairie

5.2  Patching Print.h (optional)

By making a very small change to the core Print.h file, you can add the capability to print either named or unnamed Flash objects using the familiar print[ln] syntax. What the patch does is tell class Print about Flash objects and how to print them. Note that while this patch is useful, it is entirely optional. Flash already provides two mechanisms for printing ROM strings and data structures:

    obj.print(stream);
    stream << obj;

This patch adds a third technique, the familar

    stream.print(obj);

To patch, add the following interface definition to the top of Print.h, right after the #include statements. This defines what a Flash object is, from the perspective of the Print class.

Then add a couple of inline print methods — alongside all the others — to the body of class Print:

No need to recompile anything; you are now ready to roll:

5.3  Utilisation dans un programme

Pour inclure la librairie Flash dans un programme, on ajoutera au début du programme la ligne suivante :

Pour ce faire, le plus simple est d'utiliser le menu du logiciel Arduino Programme > Importer Librairie > Flash

Voir également l'instruction #include

6.  Exemples d'utilisation :

7.  Commentaires utilisateurs

Page d'accueil de la référence Arduino en français

Corrections, suggestions et nouvelle documentation peuvent être postées sur le Forum Arduino ou à l'adresse suivante : support_at_mon-club-elec_point_fr

Le texte original de la référence Arduino est sous licence Creative Commons Attribution-ShareAlike 3.0 . Les exemples de code dans la référence sont dans le domaine public.

La présente traduction française commentée a été réalisée par Xavier HINAULT (2010-2012) (www.mon-club-elec.fr) et est sous licence Creative Commons Attribution-ShareAlike 3.0.

Cette page est une création originale du site www.mon-club-elec.fr