Update pulseIn() block to clarify time-out

Author: carlosperate

ardublockly/ardublockly_toolbox.js

@@ -147,7 +147,9 @@ Ardublockly.TOOLBOX_XML =
 '        <shadow type="io_highlow"></shadow>' +
 '      </value>' +
 '      <value name="TIMEOUT">' +
-'        <block type="math_number"></block>' +
+'        <shadow type="math_number">' +
+'          <field name="NUM">100</field>' +
+'        </shadow>' +
 '      </value>'+
 '    </block>' +
 '  </category>' +

blockly/blocks/arduino/io.js

@@ -193,50 +193,69 @@ Blockly.Blocks['io_highlow'] = {
 };
 
 Blockly.Blocks['io_pulsein'] = {
+  /**
+   * Block for measuring the duration of a pulse in an input pin.
+   * @this Blockly.Block
+   */
   init: function() {
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSEREAD);
-    this.appendValueInput("PULSETYPE")
-        .setCheck(Blockly.Types.BOOLEAN.check);
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSEON)
-        .appendField(new Blockly.FieldDropdown(
-            Blockly.Arduino.Boards.selected.digitalPins), "PULSEPIN");
-    this.setOutput(true);
-    this.setInputsInline(true);
-    this.setColour(Blockly.Blocks.io.HUE);
-    this.setTooltip(Blockly.Msg.ARD_PULSE_TIP);
-    this.setHelpUrl('https://www.arduino.cc/en/Reference/PulseIn');
+    this.jsonInit({
+      "type": "math_foo",
+      "message0": Blockly.Msg.ARD_PULSE_READ,
+      "args0": [{
+          "type": "input_value",
+          "name": "PULSETYPE",
+          "check": Blockly.Types.BOOLEAN.check
+        }, {
+          "type": "field_dropdown",
+          "name": "PULSEPIN",
+          "options": Blockly.Arduino.Boards.selected.digitalPins
+        }
+      ],
+      "output": Blockly.Types.NUMBER.output,
+      "inputsInline": true,
+      "colour": Blockly.Blocks.io.HUE,
+      "tooltip": Blockly.Msg.ARD_PULSE_TIP,
+      "helpUrl": 'https://www.arduino.cc/en/Reference/PulseIn'
+    });
   },
-      /** @return {!string} The type of input value for the block, an integer. */
+  /** @return {!string} The type of input value for the block, an integer. */
   getBlockType: function() {
     return Blockly.Types.NUMBER;
   }
 };
 
 Blockly.Blocks['io_pulsetimeout'] = {
+  /**
+   * Block for measuring (with a time-out) the duration of a pulse in an input
+   * pin.
+   * @this Blockly.Block
+   */
   init: function () {
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSEREAD);
-    this.appendValueInput("PULSETYPE")
-        .setCheck(Blockly.Types.BOOLEAN.check);
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSEON)
-        .appendField(new Blockly.FieldDropdown(
-            Blockly.Arduino.Boards.selected.digitalPins), "PULSEPIN");
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSETIMEOUT);
-    this.appendValueInput('TIMEOUT')
-        .setCheck(Blockly.Types.NUMBER.output);
-    this.appendDummyInput()
-        .appendField(Blockly.Msg.ARD_PULSETIMEOUT_MS);
-    this.setOutput(true);
-    this.setInputsInline(true);
-    this.setColour(Blockly.Blocks.io.HUE);
-    this.setTooltip(Blockly.Msg.ARD_PULSETIMEOUT_TIP);
-    this.setHelpUrl('https://www.arduino.cc/en/Reference/PulseIn');
+    this.jsonInit({
+      "type": "math_foo",
+      "message0": Blockly.Msg.ARD_PULSE_READ_TIMEOUT,
+      "args0": [{
+          "type": "input_value",
+          "name": "PULSETYPE",
+          "check": Blockly.Types.BOOLEAN.check
+        }, {
+          "type": "field_dropdown",
+          "name": "PULSEPIN",
+          "options": Blockly.Arduino.Boards.selected.digitalPins
+        }, {
+          "type": "input_value",
+          "name": "TIMEOUT",
+          "check": Blockly.Types.NUMBER.check
+        }
+      ],
+      "output": Blockly.Types.NUMBER.output,
+      "inputsInline": true,
+      "colour": Blockly.Blocks.io.HUE,
+      "tooltip": Blockly.Msg.ARD_PULSETIMEOUT_TIP,
+      "helpUrl": 'https://www.arduino.cc/en/Reference/PulseIn'
+    });
   },
-        /** @return {!string} The type of input value for the block, an integer. */
+  /** @return {!string} The type of input value for the block, an integer. */
   getBlockType: function() {
     return Blockly.Types.NUMBER;
   }

blockly/msg/json/es_ardublockly.json

@@ -4,6 +4,10 @@
 			"carlosperate"
 		]
 	},
+	"ARD_PULSE_READ": "mide pulso %1 en pin #%2",
+	"ARD_PULSE_READ_TIMEOUT": "mide pulso %1 en pin #%2 (agotar tiempo en %3 μs)",
+	"ARD_PULSE_TIP": "Mide la duración de un pulso en el pin especificado.",
+	"ARD_PULSETIMEOUT_TIP": "Mide la duración de un pulso en el pin especificado y configura el tiempo de espera en micro-segundos.",
 	"NEW_INSTANCE": "Nueva instancia...",
 	"RENAME_INSTANCE": "Renombrar la instancia...",
 	"NEW_INSTANCE_TITLE": "Nueva nombre de la instance:",

blockly/msg/json/fr_ardublockly.json

@@ -103,10 +103,8 @@
 	"ARD_TIME_INF_TIP": "Attente indéfinie, arrêt du programme.",
 	"ARD_VAR_AS": "comme",
 	"ARD_VAR_AS_TIP": "Configure une valeur à un type précis",
-	"ARD_PULSEREAD": "Lecture",
-	"ARD_PULSEON": "Impulsion sur le signal #",
-	"ARD_PULSETIMEOUT": "délai de retard",
-	"ARD_PULSETIMEOUT_MS": "",
+	"ARD_PULSE_READ": "mesure %1 impulsion sur le signal #%2",
+	"ARD_PULSE_READ_TIMEOUT": "mesure %1 impulsion sur le signal #%2 (délai de retard %3 μs)",
 	"ARD_PULSE_TIP": "Mesure la durée d'une pulsation sur le signal selectioné.",
 	"ARD_PULSETIMEOUT_TIP": "Mesure la durée d'une pulsation sur le signal selectioné, dans le delai imparti",
 	"ARD_SETTONE": "Définir une tonalité sur le signal #",

blockly/msg/json/it_ardublockly.json

@@ -104,10 +104,8 @@
 	"ARD_TIME_INF_TIP": "Attende per un tempo infinito, cioè il programma termina.",
 	"ARD_VAR_AS": "come",
 	"ARD_VAR_AS_TIP": "Imposta un tipo di valore",
-	"ARD_PULSEREAD": "Leggi",
-	"ARD_PULSEON": "impulso sul pin #",
-	"ARD_PULSETIMEOUT": "timeout dopo",
-	"ARD_PULSETIMEOUT_MS": "",
+	"ARD_PULSE_READ": "misura %1 impulso sul pin #%2",
+	"ARD_PULSE_READ_TIMEOUT": "misura %1 impulso sul pin #%2 (timeout dopo %3 μs)",
 	"ARD_PULSE_TIP": "Misura la durata di un impulso sul pin selezionato.",
 	"ARD_PULSETIMEOUT_TIP": "Misura la durata di un impulso sul pin selezionato, se è compreso all'interno del timeout.",
 	"ARD_SETTONE": "Imposta un tono sul pin #",

blockly/msg/json/nl_ardublockly.json

@@ -105,10 +105,8 @@
 	"ARD_TIME_INF_TIP": "Wacht voor altijd, stopt het programma waar deze lijn staat.",
 	"ARD_VAR_AS": "als",
 	"ARD_VAR_AS_TIP": "Wijzigt de waarde in het gegeven type",
-	"ARD_PULSEREAD": "Lees een",
-	"ARD_PULSEON": "puls op pin #",
-	"ARD_PULSETIMEOUT": "wacht maximaal",
-	"ARD_PULSETIMEOUT_MS": "milliseconden",
+	"ARD_PULSE_READ": "lees een %1 puls op pin #%2",
+	"ARD_PULSE_READ_TIMEOUT": "lees een %1 puls op pin #%2 (wacht maximaal %3 μs)",
 	"ARD_PULSE_TIP": "Meet de duur van een puls op een geselecteerde pin.",
 	"ARD_PULSETIMEOUT_TIP": "Meet de duur van een puls op een geselecteerde pin, zolang het gebeurt binnen de opgegeven maximale duur (in milliseconden).",
 	"ARD_SETTONE": "Speel noot op pin#",

blockly/msg/json/ru_ardublockly.json

@@ -103,10 +103,8 @@
 	"ARD_TIME_INF_TIP": "Ждет неопределенное время, останавливая при этом программу.",
 	"ARD_VAR_AS": "как",
 	"ARD_VAR_AS_TIP": "Приводит значение к определенному типу",
-	"ARD_PULSEREAD": "Считать",
-	"ARD_PULSEON": "импульс на пине №",
-	"ARD_PULSETIMEOUT": "с таймаутом ",
-	"ARD_PULSETIMEOUT_MS": "",
+	"ARD_PULSE_READ": "Считать %1 импульс на пине №%2",
+	"ARD_PULSE_READ_TIMEOUT": "Считать %1 импульс на пине №%2 (с таймаутом %3)",
 	"ARD_PULSE_TIP": "Измеряет длительность импульса на выбранном пине.",
 	"ARD_PULSETIMEOUT_TIP": "Измеряет длительность импульса на выбранном пине, в течение таймаута.",
 	"ARD_SETTONE": "Установить на пине №",

blockly/msg/messages_ardublockly.js

@@ -4,7 +4,7 @@
  *
  * @fileoverview  Ardublockly specific English strings.
  *
- * After modifying this file, either run "build.py" from the parent directory,
+ * After modifying this file, either run "build.py" from the blockly directory,
  * or run (from this directory):
  * ../i18n/js_to_json.py
  * to regenerate json/{en,qqq,synonyms}.json.
@@ -25,24 +25,37 @@ goog.require('Blockly.Msg');
  */
 
 /**
- * Each message is preceded with a tripple-slash comment that becomes the
+ * Each message is preceded with a triple-slash comment that becomes the
  * message descriptor.  The build process extracts these descriptors, adds
  * them to msg/json/qqq_ardublockly.json, and they show up in the translation
  * console.
  * Note the strings have to be surrounded by single quotation marks: ''
  */
 
-/// Ardublockly Types
+/**
+ * Ardublockly Types
+ */
+/// Arduino Types - Character C type char
 Blockly.Msg.ARD_TYPE_CHAR = 'Character';
+/// Arduino Types - Text C type String
 Blockly.Msg.ARD_TYPE_TEXT = 'Text';
+/// Arduino Types - Boolean type
 Blockly.Msg.ARD_TYPE_BOOL = 'Boolean';
+/// Arduino Types - Short number C type char
 Blockly.Msg.ARD_TYPE_SHORT = 'Short Number';
+/// Arduino Types - Number C type integer
 Blockly.Msg.ARD_TYPE_NUMBER = 'Number';
+/// Arduino Types - Large number C type long integer
 Blockly.Msg.ARD_TYPE_LONG = 'Large Number';
+/// Arduino Types - Decimal number C type floating point
 Blockly.Msg.ARD_TYPE_DECIMAL = 'Decimal';
+/// Arduino Types - Array
 Blockly.Msg.ARD_TYPE_ARRAY = 'Array';
+/// Arduino Types - Null C type void
 Blockly.Msg.ARD_TYPE_NULL = 'Null';
+/// Arduino Types - Undefined type
 Blockly.Msg.ARD_TYPE_UNDEF = 'Undefined';
+/// Arduino Types - Place holder value, indicates block with type not connected
 Blockly.Msg.ARD_TYPE_CHILDBLOCKMISSING = 'ChildBlockMissing';
 
 /// Arduino Blocks
@@ -137,21 +150,29 @@ Blockly.Msg.ARD_TIME_INF = 'wait forever (end program)';
 Blockly.Msg.ARD_TIME_INF_TIP = 'Wait indefinitely, stopping the program.';
 Blockly.Msg.ARD_VAR_AS = 'as';
 Blockly.Msg.ARD_VAR_AS_TIP = 'Sets a value to a specific type';
-Blockly.Msg.ARD_PULSEREAD = 'Read';
-Blockly.Msg.ARD_PULSEON = 'pulse on pin #';
-Blockly.Msg.ARD_PULSETIMEOUT = 'timeout after';
-Blockly.Msg.ARD_PULSETIMEOUT_MS = '';
+/// IO blocks - pulseIn - Block for function pulseIn(), it measure a pulse duration in a given pin.
+Blockly.Msg.ARD_PULSE_READ = 'measure %1 pulse on pin #%2';
+/// IO blocks - pulseIn - Block similar to ARD_PULSE_READ, but it adds a time-out in microseconds.
+Blockly.Msg.ARD_PULSE_READ_TIMEOUT = 'measure %1 pulse on pin #%2 (timeout after %3 μs)';
+/// IO blocks - pulseIn - Tooltip for pulseIn() block.
 Blockly.Msg.ARD_PULSE_TIP = 'Measures the duration of a pulse on the selected pin.';
-Blockly.Msg.ARD_PULSETIMEOUT_TIP = 'Measures the duration of a pulse on the selected pin, if it is within the timeout.';
+/// IO blocks - pulseIn - Tooltip for pulseIn() block when it uses the optional argument for time-out.
+Blockly.Msg.ARD_PULSETIMEOUT_TIP = 'Measures the duration of a pulse on the selected pin, if it is within the time-out in microseconds.';
 Blockly.Msg.ARD_SETTONE = 'Set tone on pin #';
 Blockly.Msg.ARD_TONEFREQ = 'at frequency';
 Blockly.Msg.ARD_TONE_TIP = 'Sets tone on pin to specified frequency within range 31 - 65535';
 Blockly.Msg.ARD_TONE_WARNING = 'Frequency must be in range 31 - 65535';
 Blockly.Msg.ARD_NOTONE = 'Turn off tone on pin #';
 Blockly.Msg.ARD_NOTONE_TIP = 'Turns the tone off on the selected pin';
 
-/// Ardublockly instances
+/**
+ * Ardublockly instances
+ */
+/// Instances - Menu item to indicate that it will create a new instance
 Blockly.Msg.NEW_INSTANCE = 'New instance...';
+/// Instances - Menu item to rename an instance name
 Blockly.Msg.RENAME_INSTANCE = 'Rename instance...';
+/// Instances - Menu item to create a new instance name and apply it to that block
 Blockly.Msg.NEW_INSTANCE_TITLE = 'New instance name:';
+/// Instances - Confirmation message that a number of instances will be renamed to a new name
 Blockly.Msg.RENAME_INSTANCE_TITLE = 'Rename all "%1" instances to:';