Espruino:Примеры/Расширение возможностей Espruino 1 – Создание собственного расширения прошивки

Материал из Онлайн справочника
< Espruino:Примеры
Версия от 15:09, 28 мая 2023; Myagkij (обсуждение | вклад)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Перейти к навигацииПерейти к поиску

Перевод: Максим Кузьмин
Проверка/Оформление/Редактирование: Мякишев Е.А.


Расширение возможностей Espruino 1 – Создание собственного расширения прошивки[1]

Это руководство служит кратким введением в написание ваших собственных расширений для Espruino, а также создание собственного двоичного кода.

Более подробно об этом можно почитать в этом руководстве по созданию собственного класса.

Внимание!

Всё, что здесь описано, работает, но тестировалось это руководство недостаточно много.

Внимание!

Поскольку я всё это затеял для того, чтобы написать пару специальных функций для ESP8266-порта Espruino, пример ниже был протестирован именно на нём. Но, к счастью, в нём много общей информации, так что, надеюсь, это поможет при использовании на других портах.

Для информации

Необходимые условия: Перед тем, как начать, у вас должно быть всё необходимое для разработки и компиляции собственной версии кода. Более подробно об этом читайте на GitHub.

Для информации

Необходимые условия: Полезно будет иметь некоторые знания в Linux, программировании на C, компоновке и т.д. и т.п. Если же вы возьмётесь за эту задачу с моим уровнем знаний, то у вас по ходу будет возникать очень много вопросов и вы периодически будете утыкаться в тупик.

Использование свободной flash-памяти для текста

Идея в том, чтобы взять неиспользуемую flash-память и сохранить в эту область текстовые данные. HTTP-сервер использует много HTML-команд, и их хранение в исходном JavaScript-коде требует много памяти. На маленьких чипах вроде ESP8266 это быстро становится проблемой.

Несколько команд для работы с flash-памятью уже есть, так что идея в том, чтобы добавить дополнительную команду вроде... 

readString(StartAddress of Flashpage, sequenceNumber inside this page)

В этом руководстве мы пройдём следующие шаги:

  • Создание файла обёртки
  • Шаблон для .h и .c
  • Добавление исходного кода функции на C
  • Внесение изменений в файл сборки
  • Запуск

Создание файла обёртки

Основа для всего нашего мероприятия – это Espruino. Соответственно, нам нужно будет использовать уже устоявшиеся правила и соглашения для этого языка. К ним относится, например, то, как называть файлы исходного кода. В нашем случае это будет «jswrap_FlashExtension». Наш код тестировался только для ESP8266, и он не является частью стандартного ESP8266-порта для Espruino, и поэтому путём для хранения файлов исходного кода будет «/Esrpuino/targets/esp8266/myLibs». Нам понадобится один заголовочный файл и один файл с исходным кодом: «jswrap_FlashExtension.h» и «jswrap_FlashExtension.c».

Шаблон для .h и .c

Давайте начнём с заголовочного файла. Часть с авторскими правами в этот раз можно пропустить. Лично я рекомендую подсмотреть, как устроены другие файлы, и делать что-то похожее. Помните, что Espruino – это язык с открытым кодом. 

#include "jsvar.h"
#include "jswrap_flash.h"

JsVar *jswrap_flash_readString(int addr, int pointer);

Подключать jsvar.h никогда не лишне, это одна из важнейших частей Espruino. Если ваше устройство работает только на JavaScript, то с помощью jsvar.h в нём будет обрабатываться хранение всего – и переменных, и исходного кода. Заголовочный файл jswrap_flash.h отвечает за все функции, связанные с flash-памятью, и некоторые из них, скорее всего, будут для вас полезны. Наконец, третья строчка – это описание функции, более подробно об этом смотрите в следующем разделе.

Добавление исходного кода функции на C

#include "jswrap_FlashExtension.h"
#include "jshardware.h"

Первая строчка добавляется для всего, что пишется на C. Со второй строчкой интереснее – это заголовочный файл для всех функций, связанных с «железом». К ним относится и считывание данных с flash-памяти. 

/*JSON{
  "type" : "staticmethod",
  "class" : "Flash",
  "name" : "readString",
  "generate" : "jswrap_flash_readString",
  "params" : [
    ["addr","int","An address in the page to store strings"],
    ["pointer","int","seqNr of string"]
  ],
  "return" : ["JsVar","A Uint8Array"]
}
 */

На первый взгляд, эта часть закомментирована и никакого толка от неё нет. Но на самом деле эти комментарии сканируются фоновым скриптом. Как видите, некоторые данные здесь представлены в JSON-формате. И они конвертируются в ещё один C-файл. В конце концов, этот сгенерированный файл будет связующим звеном между JavaScript-файлом и скомпилированной C-функцией. Простите, если сумбурно, уверен, есть немало людей, которые объяснят это лучше меня.

Начнём давайте с краткого описания пути – текст хранится в flash-памяти, и наше расширение, напоминаю, предназначено для его считывания. Начало каждой страницы flash-памяти – это набор указателей на сами данные. Начало и размер каждого текстового элемента хранятся в виде 16-битных значений. Сам текст начинается после части с указателями. Вариантов того, как сохранять данные, на самом деле много, но в нашем случае вполне хватит и этого. 

JsVar *jswrap_flash_readString(int addr, int pointer){
  int startAddr, length, pnt,tmp;
  pnt = addr + pointer * 4;
  jshFlashRead(&tmp, (uint32_t)(pnt), 4);
  length = tmp >> 16;
  startAddr = tmp & 0xffff;
  return jswrap_flash_read(length,addr + startAddr);
}

Считывание данных из flash-памяти – это функция, связанная с «железом» (jshFlashRead), которая выполняется в границах 4 байт. Значение Int32 поделено на начало и размер. Наконец, нам остаётся лишь воспользоваться уже готовой функцией чтения из объекта Flash, чтобы прочесть текст. Формат возвращаемых данных – это Uint8Array, который можно без труда преобразовать в строку при помощи E.toString().

Внесение изменений в файл сборки

Теперь, когда исходный код готов, настало время для компиляции и компоновки. Файлу сборки необходимо знать о дополнительных файлах. И это ответ на вопрос о том, зачем нам нужна поддиректория myLibs – чтобы не вносить изменения для каждого нового расширения, мы будем искать файлы только в этой директории. 

 ifdef USE_ESP8266
 DEFINES += -DUSE_ESP8266
 WRAPPERSOURCES += libs/network/esp8266/jswrap_esp8266_network.c \
   targets/esp8266/jswrap_esp8266.c
 INCLUDE += -I$(ROOT)/libs/network/esp8266
 SOURCES += \
 libs/network/esp8266/network_esp8266.c\
 libs/network/esp8266/pktbuf.c\
 libs/network/esp8266/ota.c
  ifdef USE_MYLIB
   WRAPPERSOURCES += $(wildcard targets/esp8266/myLibs/jswrap*.c)
   SOURCES += $(wildcard targets/esp8266/myLibs/lib*.c)
  endif
 endif

В файле сборки уже есть фрагмент, который добавляет во внутренний список файлы, специфичные для платы. Если в USE_MYLIB будет задано «1», шаблонная функция будет искать и добавлять дополнительные файлы. Строчки рядом с шаблонными функциями не являются частью стандартного файла сборки. Их нужно обязательно добавить перед следующим этапом.

Запуск

Итак, все изменения внесены, теперь пора запустить файл сборки. В моём случае запись прошивки выполнялась при помощи программатора NodeMCU под Windows. В целях упрощения этого процесса у моей виртуальной машины и Windows есть общая папка. Сам файл сборки создаёт TAR-файл со всеми двоичными файлами. Для обработки TAR-файлов есть специальные приложения, но гораздо проще сделать это в самой виртуальной машине. 

ESP8266_BOARD=1 USE_MYLIB=1 make
tar -xzf espruino*.tgz -C /mnt/hgfs/C_tmp_VMWare
cd /mnt/hgfs/C_tmp_VMWare
rm -rvf espruino
mv espruino* espruino
cd

Разумеется, всё никогда не работает идеально и со всем этим могут возникнуть проблемы. Вы всегда можете оставить обратную связь об этом руководстве и возникших проблемах на форуме Espruino или на Gitter.

См.также

Внешние ссылки

  1. ↑ www.espruino.com - Extending Espruino 1 - Making own firmware extension
Партнерские ресурсы
Криптовалюты
Магазины
Хостинг
Разное
Справочник по API Espruino
Глобальные методы, переменные и объекты • acceleration() • analogRead() • analogWrite() • arguments • atob() • Объект Bluetooth • btoa() • changeInterval() • clearInterval() • clearTimeout() • clearWatch() • compass() • decodeURIComponent() • digitalPulse() • digitalRead() • digitalWrite() • dump() • echo() • edit() • encodeURIComponent() • eval() • FET • getPinMode() • getSerial() • getTime() • global • HIGH • Объект I2C1 • Объект I2C2 • Объект I2C3 • Infinity • isFinite() • isNaN() • load() • Объект LoopBackA • Объект LoopBackB • LOW • NaN • parseFloat() • parseInt() • peek16() • peek32() • peek8() • pinMode() • poke16() • poke32() • poke8() • print() • require() • reset() • save() • SCL • SDA • Объект Serial1 • Объект Serial2 • Объект Serial3 • Объект Serial4 • Объект Serial5 • Объект Serial6 • setBusyIndicator() • setDeepSleep() • setInterval() • setSleepIndicator() • setTime() • setTimeout() • setWatch() • shiftOut() • show() • Объект SPI1 • Объект SPI2 • Объект SPI3 • Объект Telnet • Объект Terminal • trace() • Объект USB • VIBRATE
Класс AES • decrypt() • encrypt()
Класс Array • Array() • concat() • every() • fill() • filter() • find() • findIndex() • forEach() • includes() • indexOf() • isArray() • join() • length • map() • pop() • push() • reduce() • reverse() • shift() • slice() • some() • sort() • splice() • toString() • unshift()
Класс ArrayBuffer • ArrayBuffer() • byteLength
Класс ArrayBufferView • buffer • byteLength • byteOffset • fill() • filter() • find() • findIndex() • forEach() • includes() • indexOf() • join() • map() • reduce() • reverse() • set() • slice() • sort()
Класс Bangle • accel • accelRd() • accelWr() • aiGesture • beep() • buzz() • charging • compassWr() • dbg() • drawWidgets() • F_BEEPSET • faceUp • gesture • getAccel() • getCompass() • getLCDMode() • getLogo() • GPS • GPS-raw • HRM • ioWr() • isCharging() • isLCDOn() • lcdPower • lcdWr() • loadWidgets() • mag • off() • project() • setCompassPower() • setGPSPower() • setHRMPower() • setLCDBrightness() • setLCDMode() • setLCDOffset() • setLCDPower() • setLCDTimeout() • setOptions() • setPollInterval() • showLauncher() • step • swipe • touch • twist
Класс BluetoothDevice • connected • gatt • gattserverdisconnected • passkey • passkeyRequest • rssi • sendPasskey()
Класс BluetoothRemoteGATTCharacteristic • characteristicvaluechanged • readValue() • startNotifications() • stopNotifications() • writeValue()
Класс BluetoothRemoteGATTServer • connect() • disconnect() • getPrimaryService() • getPrimaryServices() • getSecurityStatus() • setRSSIHandler() • startBonding()
Класс BluetoothRemoteGATTService • getCharacteristic() • getCharacteristics()
Класс Boolean • Boolean()
Библиотека CC3000 • connect()
Класс Console • log()
Библиотека crypto • AES • PBKDF2() • SHA1() • SHA224() • SHA256() • SHA384() • SHA512()
Класс DataView • DavaView() • getFloat32() • getFloat64() • getInt16() • getInt32() • getInt8() • getUint16() • getUint32() • getUint8() • setFloat32() • setFloat64() • setInt16() • setInt32() • setInt8() • setUint16() • setUint32() • setUint8()
Класс Date • Date() • getDate() • getDay() • getFullYear() • getHours() • getMilliseconds() • getMinutes() • getMonth() • getSeconds() • getTime() • getTimezoneOffset() • now() • parse() • setDate() • setFullYear() • setHours() • setMilliseconds() • setMinutes() • setMonth() • setSeconds() • setTime() • toISOString() • toJSON() • toString() • toUTCString() • valueOf()
Библиотека dgram • createSocket()
Класс dgramSocket • addMembership() • bind() • Функция close() • Событие close() • message • send()
Класс E • asm() • clip() • compiledC() • connectSDCard() • convolve() • CRC32() • defrag() • dumpFragmentation() • dumpFreeList() • dumpLockedVars() • dumpStr() • dumpTimers() • dumpVariables() • enableWatchdog() • errorFlag • FFT() • flashFatFS() • getAddressOf() • getAnalogVRef() • getBattery() • getConsole() • getErrorFlags() • getFlags() • getRTCPrescaler() • getSizeOf() • getTemperature() • HSBtoRGB() • hwRand() • init • kickWatchdog() • kill • lockConsole() • lookupNoCase() • mapInPlace() • memoryArea() • memoryMap() • nativeCall() • openFile() • pipe() • reboot() • reverseByte() • sendUSBHID() • setBootCode() • setClock() • setConsole() • setFlags() • setPassword() • setRTCPrescaler() • setTimeZone() • setUSBHID() • showAlert() • showMenu() • showMessage() • showPrompt() • srand() • sum() • toArrayBuffer() • toJS() • toString() • toUint8Array() • unmountSD() • variance()
Класс Error • Error() • toString()
Библиотека ESP8266 • crc32() • deepSleep() • dumpSocketInfo() • getFreeFlash() • getResetInfo() • getState() • logDebug() • neopixelWrite() • ping() • printLog() • readLog() • reboot() • setCPUFreq() • setLog()
Класс Ethernet • getHostname() • getIP() • getStatus() • setHostname() • setIP()
Класс File • close() • pipe() • read() • seek() • skip() • write()
Библиотека Flash • erasePage() • getFree() • getPage() • read() • write()
Класс Float32Array • Float32Array()
Класс Float64Array • Float64Array()
Библиотека fs • appendFile() • appendFileSync() • mkdir() • mkdirSync() • pipe() • readdir() • readdirSync() • readFile() • readFileSync() • statSync() • unlink() • unlinkSync() • writeFile() • writeFileSync()
Класс Function • apply() • bind() • call() • Function() • replaceWith()
Класс Graphics • asBMP() • asImage() • asURL() • buffer • clear() • clearRect() • createArrayBuffer() • createCallback() • createImage() • createSDL() • drawCircle() • drawEllipse() • drawImage() • drawImages() • drawLine() • drawLineAA() • drawPoly() • drawPolyAA() • drawRect() • drawString() • dump() • fillCircle() • fillEllipse() • fillPoly() • fillRect() • flip() • getBgColor() • getColor() • getFont() • getFontHeight() • getFonts() • getHeight() • getInstance() • getModified() • getPixel() • getWidth() • lineTo() • moveTo() • quadraticBezier() • reset() • scroll() • setBgColor() • setClipRect() • setColor() • setFont() • setFontAlign() • setFontBitmap() • setFontCustom() • setFontVector() • setPixel() • setRotation() • stringWidth() • toColor() • transformVertices()
Библиотека heatshrink • compress() • decompress()
Библиотека http • createServer() • get() • request()
Класс httpCRq • drain • end() • error • write()
Класс httpCRs • available() • close • data • error • headers • httpVersion • pipe() • read() • statusCode • statusMessage
Класс httpSRq • available() • close • data • headers • method • pipe() • read() • url
Класс httpSRs • close • drain • end() • headers • setHeader() • write() • writeHead()
Класс httpSrv • close() • listen()
Класс I2C • find() • I2C() • readFrom() • setup() • writeTo()
Класс Int16Array • Int16Array()
Класс Int32Array • Int32Array()
Класс Int8Array • Int8Array()
Класс InternalError • InternalError() • toString()
Класс JSON • parse() • stringify()
Класс Math • abs() • acos() • asin() • atan() • atan2() • ceil() • clip() • cos() • E • exp() • floor() • LN10 • LN2 • log() • LOG10E • LOG2E • max() • min() • PI • pow() • random() • round() • sin() • sqrt() • SQRT1_2 • SQRT2 • tan() • wrap()
Класс Microbit • accel() • accelOff() • accelOn() • accelWr() • gesture • mag() • MIC • MIC_ENABLE • play() • record() • SPEAKER
Класс Modules • addCached() • getCached() • removeAllCached() • removeCached()
Библиотека neopixel • write()
Библиотека net • connect() • createServer()
Библиотека NetworkJS • create()
Класс NodeMCU • A0 • D0 • D1 • D2 • D3 • D4 • D5 • D6 • D7 • D8 • D9 • D10
Класс NRF • characteristicsDiscover • connect • connect() • disconnect • disconnect() • filterDevices() • findDevices() • getAddress() • getAdvertisingData() • getBattery() • getSecurityStatus() • HID • nfcAndroidApp() • NFCoff • NFCon • nfcPair() • nfcRaw() • NFCrx • nfcSend() • nfcStart() • nfcStop() • nfcURL() • requestDevice() • restart() • security • sendHIDReport() • servicesDiscover • setAddress() • setAdvertising() • setConnectionInterval() • setLowPowerConnection() • setRSSIHandler() • setScan() • setScanResponse() • setSecurity() • setServices() • setTxPower() • setWhitelist() • sleep() • updateServices() • wake()
Класс Nucleo • A0 • A1 • A2 • A3 • A4 • A5 • D0 • D1 • D2 • D3 • D4 • D5 • D6 • D7 • D8 • D9 • D10 • D11 • D12 • D13 • D14 • D15
Класс Number • MAX_VALUE • MIN_VALUE • NaN • NEGATIVE_INFINITY • Number() • POSITIVE_INFINITY • toFixed()
Класс Object • assign() • clone() • create() • defineProperties() • defineProperty() • emit() • getOwnPropertyDescriptor() • getOwnPropertyNames() • getPrototypeOf() • hasOwnProperty() • keys() • length • Object() • on() • removeAllListeners() • removeListener() • setPrototypeOf() • toString() • valueOf()
Класс OneWire • OneWire() • read() • reset() • search() • select() • skip() • write()
Класс Pin • getInfo() • getMode() • mode() • Pin() • read() • reset() • set() • toggle() • write() • writeAtTime()
Класс Pixl • getBatteryPercentage() • lcdw() • menu() • setContrast() • setLCDPower()
Класс process • env • memory() • uncaughtException • version
Класс Promise • all() • catch() • Promise() • reject() • resolve() • then()
Класс Puck • accel • accel() • accelOff() • accelOn() • accelRd() • accelWr() • capSense() • getBatteryPercentage() • getTemperature() • IR() • light() • mag() • mag • magOff() • magOn() • magRd() • magTemp() • magWr() • selfTest()
Класс ReferenceError • ReferenceError() • toString()
Класс RegExp • exec() • RegExp() • test()
Класс Serial • available() • data • find() • framing • inject() • parity • pipe() • print() • println() • read() • Serial() • setConsole() • setup() • unsetup() • write()
Класс Server • close() • listen()
Класс Socket • available() • close • data • drain • end() • error • pipe() • read() • write()
Класс SPI • find() • send() • send4bit() • send8bit() • setup() • SPI() • write()
Библиотека Storage • compact() • debug() • erase() • eraseAll() • getFree() • list() • open() • read() • readArrayBuffer() • readJSON() • write() • writeJSON()
Класс StorageFile • erase() • getLength() • read() • readLine() • write()
Класс String • charAt() • charCodeAt() • endsWith() • fromCharCode() • includes() • indexOf() • lastIndexOf() • length • match() • padEnd() • padStart() • repeat() • replace() • slice() • split() • startsWith() • String() • substr() • substring() • toLowerCase() • toUpperCase() • trim()
Класс SyntaxError • SyntaxError() • toString()
Библиотека TelnetServer • setOptions()
Библиотека tensorflow • create()
Класс TFMicroInterpreter • getInput() • getOutput() • invoke()
Библиотека tls • connect()
Библиотека tv • setup()
Класс TypeError • toString() • TypeError()
Класс Uint16Array • Uint16Array()
Класс Uint24Array • Uint24Array()
Класс Uint32Array • Uint32Array()
Класс Uint8Array • Uint8Array()
Класс Uint8ClampedArray • Uint8ClampedArray()
Класс url • parse()
Класс Waveform • startInput() • startOutput() • stop() • Waveform()
Библиотека WiFi • associated • auth_change • connect() • connected • dhcp_timeout • disconnect() • disconnected • getAPDetails() • getAPIP() • getDetails() • getHostByName() • getHostname() • getIP() • getStatus() • ping() • probe_recv • restore() • save() • scan() • setAPIP() • setConfig() • setIP() • setSNTP() • sta_joined • sta_left • startAP() • stopAP() • turbo()
Класс WioLTE • A4 • A6 • D20 • D38 • I2C • LED() • setGrovePower() • setLEDPower() • UART
Библиотека WIZnet • connect()
Класс WLAN • connect() • disconnect() • getIP() • reconnect() • setIP()

Источник — http://wikihandbk.com/ruwiki/index.php?title=Espruino:Примеры/Расширение_возможностей_Espruino_1_–_Создание_собственного_расширения_прошивки&oldid=7739269