Féroce Lapin: Arduino et BBEdit / TextWrangler

Si comme moi vous codez sur un Mac, il y a de forte chance que vous ayez vos petites habitudes avec les outils de Barebones, à savoir TextWrangler ou BBEdit. Lorsque l'on code beaucoup en PHP (ce qui est mon cas) avec l'un de ces deux outils et que l'on passe sous l'Ide Arduino, il y a un choc... Pourtant les outils de Barebones peuvent remplacer l'éditeur de l'Ide de l'Arduino. Voyons ça!

Note: tout ce qui est expliqué ici concerne aussi bien TextWrangler que BBEdit.

Côté Arduino

Ouvrez l'Ide Arduino et dans les préférences, cochez la case "Utiliser un éditeur externe". C'est tout!

Côté TextWrangler

Allez dans le menu juste avant le menu Help donc le menu avec une icône en forme de petit parchemin. Deux cas possibles:

vous avez déjà créé au moins un script pour piloter TextWrangler
vous n'avez jamais utilisé ce menu, donc sous les trois premières entrées, il n'y a rien.

Vous avez déjà au moins un script

Si vous en êtes l'auteur, je suppose que vous savez comment créer un script, donc à vous de jouer. Le script est un peu plus bas dans cet article. Il lance l'Ide Arduino puis simule une compilation-téléversement avec Cmd-U. Il ouvre aussi le Moniteur série (Shift-Cmd-M).
Si vous n'êtes pas l'auteur du ou des scripts actuellement disponibles, la solution la plus simple est la suivante:

Cliquez dans le menu sur "Open Scripts Folder". Dans la fenêtre qui s'ouvre et qui liste tous les scripts, cliquez avec le bouton droit sur un des scripts (.scpt) et choisissez "Dupliquez". Donnez à ce fichier le nom que vous voulez voir apparaître dans le menu (moi je l'ai nommé "Arduino compile and run.scpt").
Double cliquez sur ce fichier ce qui ouvrira l'éditeur de script de votre Mac. Effacez le script actuel et collez à la place le script qui est un peu plus bas dans cet article. Une fois que c'est fait, cliquez sur le petit marteau en haut de la fenêtre pour validez le script, puis cliquez sur "Enregistrer" dans le menu "Fichier".

Vous n'avez aucun script

Dans ce cas dans le menu de TextWrangler, cliquez sur "Open Scripting Editor". Dans la fenêtre d'édition, recopiez le code ci-dessous. Cliquez ensuite sur le petit marteau pour valider le script. Ensuite, cliquez dans le menu sur "Enregistrer" pour sauvez le fichier en lui donnant le nom que vous voulez voir apparaître dans le menu (moi je l'ai nommé "Arduino compile and run.scpt"). Le script doit être sauvé dans le dossier Bibliothéque/Application Support/TextWrangler/Scripts. Si vous ne savez pas comment y accéder, sauvez le script sur le bureau. Nous verrons dans quelques instants comment accéder au dossier Bibliothéque pour y déposer un autre fichier et vous aurez simplement à recopier le script au bon endroit.

Attention: nous parlons ici du dossier Bibliothéque de votre compte utilisateur. Pas du dossier Bibliothéque "général".

set MYFilePath to quoted form of POSIX path of (path to documents folder)
set MyArduinoPath to quoted form of POSIX path of (path to applications folder) & "/Dev/Arduino.app" -- set the path to your Arduino app here, this is the default location.

tell application "TextWrangler"
 set TextWranglerFilePath to get file of first document
 set DocName to get name of first document
 copy first word of DocName to TextWranglerDocName
end tell

set ActiveFile to quoted form of the POSIX path of TextWranglerFilePath

tell application "Arduino" to activate
delay 1
tell application "System Events" to set ArduinoFileName to get name of first window in process "Arduino"

if ArduinoFileName starts with TextWranglerDocName then
 tell application "System Events" to tell process "Arduino"
  keystroke "u" using command down
 end tell
else
 tell application "Arduino" to activate
 set command to "open -a " & MyArduinoPath & " " & ActiveFile
 do shell script command
 delay 2
 tell application "System Events" to tell process "Arduino"
  keystroke "u" using command down
  keystroke "m" using {shift down, command down}
 end tell
end if

Note: ce script est basé sur celui trouvé dans un message du forum Arduino.

On test...

Relancez TextWrangler. Dans le menu vous devez maintenant voir l'entrée Arduino. Une fois que vous aurez chargé un fichier .ino, il vous suffira de cliquez sur cette entrée Arduino pour que cela lance l'Ide Arduino qui chargera le fichier le compilera et l'enverra sur votre carte. Si rien ne se passe au niveau de l'Ide, cliquez une nouvelle fois dans le menu de TextWrangler.

Colorer le code

Outre le fait d'avoir maintenant votre code qui s'ouvre dans TextWrangler, avoir du code coloré, c'est quand même plus sympa.

Pour cela, recopier le code ci-dessous et sauvez-le sous le nom "arduino.plist" (faites un copier collez dans TextWrangler). Ce fichier doit être sauvé dans le dossier Bibliothéque de votre compte utilisateur. Le problème c'est que par défaut ce dossier est caché. Pour le faire apparaître, trois options, expliquées ici.
Une fois ce dossier ouvert, ouvrez son sous-dossier "Application Support". Cherchez et ouvrez le dossier TextWrangler (ou BBedit) et dépose le fichier "arduino.plist" dans le dossier "Language Modules".

Note: vous verrez, au même niveau que ce dossier "Language Modules" le dossier "Scripts".

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>BBEditDocumentType</key>
    <string>CodelessLanguageModule</string>
    <key>BBLMColorsSyntax</key>
    <true />
    <key>BBLMIsCaseSensitive</key>
    <true />
    
    <!-- Mots clefs qui seront en vert foncé -->
    <!-- Ce sont les noms des fonctions -->
    <key>BBLMPredefinedNameList</key>
    <array>
      <string>define</string>
      <string>HIGH</string>
      <string>LOW</string>
      <string>INPUT</string>
      <string>INPUT_PULLUP</string>
      <string>OUTPUT</string>
      <string>DEC</string>
      <string>BIN</string>
      <string>HEX</string>
      <string>OCT</string>
      <string>BYTE</string>
      <string>PI</string>
      <string>HALF_PI</string>
      <string>TWO_PI</string>
      <string>LSBFIRST</string>
      <string>MSBFIRST</string>
      <string>CHANGE</string>
      <string>FALLING</string>
      <string>RISING</string>
      <string>DEFAULT</string>
      <string>EXTERNAL</string>
      <string>INTERNAL</string>
      <string>INTERNAL1V1</string>
      <string>INTERNAL2V56</string>
  <string>true</string>
  <string>false</string>
  <string>FILE_READ</string>
  <string>FILE_WRITE</string>
    </array>
    
    <!-- Mots clefs qui seront en bleu -->
    <key>BBLMKeywordList</key>
    <array>
   <string>include</string>
      <string>+=</string>
      <string>+</string>
      <string>[]</string>
      <string>=</string>
      <string>&</string>
      <string>|</string>
      <string>,</string>
      <string>//</string>
      <string>?:</string>
      <string>{}</string> 
      <string>--</string>
      <string>/</string>
      <string>/*</string>
      <string>.</string>
      <string>==</string>
      <string><</string>
      <string><=</string>
      <string>++</string>
      <string>!=</string>
      <string><<</string>
      <string><</string>
      <string><=</string>
      <string>>></string>
      <string>></string>
      <string>>></string>
      <string>&&</string>
      <string>!</string>
      <string>||</string>
      <string>-</string>
      <string>%</string>
      <string>*</string>
      <string>()</string>
      <string>>></string>
      <string>>></string>
      <string>;</string>
      <string>-=</string>

      <string>indexOf</string>
      <string>substring</string>
  <string>trim</string>
  <string>replace</string>    
    <string>charAt</string>  
      <string>boolean</string>
      <string>break</string>
      <string>byte</string>
      <string>case</string>
      <string>char</string>
      <string>class</string>
      <string>continue</string>
      <string>default</string>
      <string>do</string>
      <string>double</string>
      <string>else</string>
      <string>float</string>
      <string>for</string>
      <string>if</string>
      <string>int</string>
      <string>long</string>
      <string>new</string>
      <string>null</string>
      <string>private</string>
      <string>protected</string>
      <string>public</string>
      <string>return</string>
      <string>short</string>
      <string>signed</string>
      <string>static</string>
      <string>String</string>
      <string>switch</string>
      <string>this</string>
      <string>throw</string>
      <string>try</string>
      <string>unsigned</string>
      <string>void</string>
      <string>while</string>
      <string>word</string>
      <string>const</string>
      <string>boolean</string>
      <string>byte</string>
      <string>char</string>
      <string>float</string>
      <string>int</string>
      <string>long</string>
      <string>word</string>
      <string>abs</string>
      <string>acos</string>
      <string>asin</string>
      <string>atan</string>
      <string>atan2</string>
      <string>ceil</string>
      <string>constrain</string>
      <string>cos</string>
      <string>degrees</string>
      <string>exp</string>
      <string>floor</string>
      <string>log</string>
      <string>map</string>
      <string>max</string>
      <string>min</string>
      <string>radians</string>
      <string>random</string>
      <string>randomSeed</string>
      <string>round</string>
      <string>sin</string>
      <string>sq</string>
      <string>sqrt</string>
      <string>tan</string>
      <string>bitRead</string>
      <string>bitWrite</string>
      <string>bitSet</string>
      <string>bitClear</string>
      <string>bit</string>
      <string>highByte</string>
      <string>lowByte</string>
      <string>analogReference</string>
      <string>analogRead</string>
      <string>analogWrite</string>
      <string>attachInterrupt</string>
      <string>detachInterrupt</string>
      <string>delay</string>
      <string>delayMicroseconds</string>
      <string>digitalWrite</string>
      <string>digitalRead</string>
      <string>interrupts</string>
      <string>millis</string>
      <string>micros</string>
      <string>noInterrupts</string>
      <string>noTone</string>
      <string>pinMode</string>
      <string>pulseIn</string>
      <string>shiftIn</string>
      <string>shiftOut</string>
      <string>tone</string>
      <string>Serial</string>
      <string>Serial1</string>
      <string>Serial2</string>
      <string>Serial3</string>
      <string>begin</string>
      <string>end</string>
      <string>peek</string>
      <string>read</string>
      <string>print</string>
      <string>println</string>
      <string>available</string>
      <string>flush</string>
      <string>setup</string>
      <string>loop</string>
      <string>equals</string>
      <string>toInt</string>
      
      <!-- Servo motor -->
       <string>attach</string>     
        <string>write</string> 
      <string>writeMicroseconds</string>     
       <string>read</string> 
       <string>attached</string>        
       <string>detach</string> 
       
       <!-- Stepper -->
        <string>Stepper</string> 
       <string>setSpeed</string> 
        <string>step</string> 
        
       <!-- SD -->
       <string>readStringUntil</string> 
       <string>open</string> 
       <string>close</string> 
       <string>begin</string> 
       <string>exists</string>                  
       <string>mkdir</string> 
       <string>remove</string>        
       <string>rmdir</string> 
        <string>name</string> 
       <string>available</string> 
       <string>flush</string> 
       <string>peek</string>                  
       <string>position</string> 
       <string>print</string>        
       <string>seek</string> 
       <string>size</string> 
       <string>read</string> 
       <string>write</string> 
       <string>isDirectory</string>                  
       <string>openNextFile</string> 
       <string>rewindDirectory</string>        

       <!-- LiquidCrystal -->
       <string>LiquidCrystal</string>  
       <string>begin</string>  
       <string>clear</string>  
       <string>home</string>  
       <string>setCursor</string>  
       <string>write</string>  
       <string>print</string>  
       <string>cursor</string>  
       <string>noCursor</string>  
       <string>blink</string>  
       <string>noBlink</string>  
       <string>display</string>  
       <string>noDisplay</string>  
       <string>scrollDisplayLeft</string>  
       <string>scrollDisplayRight</string>  
       <string>autoscroll</string>  
       <string>noAutoscroll</string>  
       <string>leftToRight</string>  
       <string>rightToLeft</string>  
       <string>createChar</string>  

    </array>
    <key>BBLMLanguageCode</key>
    <string>Adno</string>
    <key>BBLMLanguageDisplayName</key>
    <string>Arduino</string>
    <key>BBLMSuffixMap</key>
    <array>
      <dict>
        <key>BBLMLanguageSuffix</key>
        <string>.ino</string>
      </dict>
    </array>
    <key>BBLMScansFunctions</key>
    <true />
      <key>Language Features</key>
    <dict>
        <key>Identifier and Keyword Character Class</key>
        <string>0-9A-Z_a-z</string>

        <key>Comment Pattern</key>
        <string><![CDATA[(?x:
            (?>  (?<!\\) //  .*       $            ) |
            (?>  /\*         (?s:.*?) (?: \*/ | \z ) )
        )]]></string>

        <key>Function Pattern</key>
        <string><![CDATA[(?x:
            (?P<leadspace>^\s*)
            (?P<function>
                (?:export\s+)?
                (?:class|interface|function)\s+
                    (?P<function_name>
                        ([A-Za-z_$][\w$.]*)
                    )
                (?s:.+?)
                \r(?P=leadspace)\}
            )
        )]]></string>

        <key>String Pattern</key>
        <string><![CDATA[(?x:
            (?> "   [^"\r]*   ") |
            (?> '   [^'\r]*   ') |
            (?> `   [^`]*     `)
        )]]></string>

        <key>Skip Pattern</key>
        <string><![CDATA[
        (?x:
            (?P>comment) |
            (?P>string)
        )]]></string>

    </dict>
</dict>
</plist>

Une fois le fichier recopié au bon endroit, s'il est encore ouvert dans TextWrangler, fermez ce fichier (quand ce fichier est ouvert et en édition, la coloration ne fonctionne pas).
Désormais, lorsque vous ouvrirez un fichier .ino avec TextWrangler, sa syntaxe sera colorisée.

Attention: le lien entre la coloration et le fichier se fait par l'extension qui doit donc être ".ino"

Ouvrir les .ino avec TextWrangler

Pour que ce soit TextWrangler qui ouvre les fichiers .ino lorsque vous cliquez sur ceux-ci, deux options:

Cliquez sur le fichier .ino avec le bouton droit de votre souris et choisissez "Ouvrir avec..." puis "Autre...". Sélectionnez TextWrangler (ou BBedit) dans le sélecteur de fichier. Si vous cochez la case "Toujours ouvrir avec..." ce fichier (et seulement celui-ci) s'ouvrira toujours avec TextWrangler. Les autres ".ino" continueront à s'ouvrir avec l'Ide Arduino.
Pour que tous les fichiers .ino s'ouvrent avec TextWrangler, cliquez sur un fichier .ino avec le bouton droit et choisissez "Lire les informations". Sélectionnez TextWrangler ou BBedit dans le menu de la zone "Ouvrir avec". En cliquant sur "Tout modifier", tous les fichiers .ino seront modifiés pour s'ouvrir avec l'outil que vous aurez choisi.

Petites astuces...

Première fois

Quand vous ouvrez la première fois l'Ide Arduino via TextWrangler, il arrive que l'Ide n'ouvre pas le fichier. Il suffit de recliquer sur le menu dans TextWrangler.

Position des fenêtres

Vous noterez également que l'Ide Arduino sauvegarde la taille et la position de sa fenêtre d'édition lorsque vous le quittez, tout comme la position de la fenêtre du Moniteur Série.
Pour ma part j'ai donc positionné la fenêtre de l'éditeur en bas à droite, en augmentant la hauteur de la zone qui informe sur la compilation et en masquant le code (puisque je l'ai dans TextWrangler), le Moniteur série étant ouvert en partie supérieure (voir copie d'écran ci-dessous).

Pré-remplir un nouveau fichier

Quand vous créez un nouveau Sketch sur l'Ide Arduino, un bout de code est automatiquement généré. Pour faire la même chose lorsque vous créer un nouveau Sketch sous TextWrangler rien de bien compliqué. Il suffit là-encore de faire un petit Script, comme celui que nous venons de créer pour lancer l'Ide, de le nommer comme vous voulez (par exemple "Arduino new.scpt") et de le mettre dans le dossier Scripts de TextWrangler. Voici le script:

tell application "TextWrangler"
 activate
 
 
 set arduino_new to "void setup() {
  // put your setup code here, to run once:

}

void loop() {
  // put your main code here, to run repeatedly:

}"
 
 set selection to arduino_new
 
end tell

Pas besoin d'être un génie du code pour comprendre le principe et de voir qu'au lieu de simplement créer les fonctions setup() et loop() vous pouvez aussi ajouter un header avec votre nom, date, des defines, des includes, etc...

Conclusion

Avec quelques réglages simples, il est donc possible d'utiliser TextWrangler en lieu et place de l'éditeur de l'Ide Arduino. Il est aussi possible de faire la même chose pour compiler du C ou faire de l'assembleur, tout en gardant ses habitudes. De plus, la facilité de création des scripts fait qu'il est assez simple de se créer des raccourcis, générant automatiquement du code.

Féroce Lapin

dimanche 10 décembre 2017

Arduino et BBEdit / TextWrangler