Espruino:Примеры/Создание и подача на рассмотрение модулей (или изменений в них): различия между версиями

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
Нет описания правки
Нет описания правки
 
(не показана 1 промежуточная версия этого же участника)
Строка 12: Строка 12:
* Назовите свой модуль в честь устройства, для которого разработан ваш код (но постарайтесь, чтобы название было как можно короче – как ''«[[PCD8544]]»'' для чипа, управляющего работой [[LCD-дисплея]] [[Nokia]]), а в конце добавьте ''«[[.js]]»''. В результате у вас должно получиться что-то вроде ''«MOD123.js»''.
* Назовите свой модуль в честь устройства, для которого разработан ваш код (но постарайтесь, чтобы название было как можно короче – как ''«[[PCD8544]]»'' для чипа, управляющего работой [[LCD-дисплея]] [[Nokia]]), а в конце добавьте ''«[[.js]]»''. В результате у вас должно получиться что-то вроде ''«MOD123.js»''.


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript">
* Скопируйте в этот файл вот этот шаблон:
* Скопируйте в этот файл вот этот шаблон:
/* Copyright (c) 2014 Ваше имя.  
/* Copyright (c) 2014 Ваше имя.  
Строка 70: Строка 70:
* Скопируйте в него шаблон ниже (первым словом в строчке '''KEYWORDS''' всегда должно стоять слово '''Module''').
* Скопируйте в него шаблон ниже (первым словом в строчке '''KEYWORDS''' всегда должно стоять слово '''Module''').


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript">
<!--- Copyright (c) 2014 Ваше имя.
<!--- Copyright (c) 2014 Ваше имя.
       Информацию о лицензии смотрите в файле LICENSE. -->  
       Информацию о лицензии смотрите в файле LICENSE. -->  
Строка 102: Строка 102:
Кроме того, если у вашего модуля больше одной функции, вы можете добавить в него '''APPEND_JSDOC'''. Это просканирует указанный JS-файл (то есть в данном случае – '''MOD123.js''') на предмет экспортированных функций и комментариев в формате '''/** ... */''', чтобы потом добавить их в ваш модуль в качестве справочной информации.
Кроме того, если у вашего модуля больше одной функции, вы можете добавить в него '''APPEND_JSDOC'''. Это просканирует указанный JS-файл (то есть в данном случае – '''MOD123.js''') на предмет экспортированных функций и комментариев в формате '''/** ... */''', чтобы потом добавить их в ваш модуль в качестве справочной информации.


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript">
Reference
Reference
---------
---------
Строка 111: Строка 111:
Кроме того, вы можете добавить в него '''APPEND_USES'''. Теперь если у какого-то [https://www.espruino.com/Writing+Tutorials руководства] вверху будет написано '''USES: MOD123''', то он будет указан на странице вашего модуля:
Кроме того, вы можете добавить в него '''APPEND_USES'''. Теперь если у какого-то [https://www.espruino.com/Writing+Tutorials руководства] вверху будет написано '''USES: MOD123''', то он будет указан на странице вашего модуля:


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript">
Using
Using
-----
-----
Строка 124: Строка 124:
=См.также=
=См.также=


{{ads}}
 


=Внешние ссылки=
=Внешние ссылки=
Строка 130: Строка 130:
<references />
<references />


{{Навигационная таблица/Espruino}}
{{Навигационная таблица/Портал/Espruino}}
{{Навигационная таблица/Телепорт}}

Текущая версия от 06:53, 24 мая 2023

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


Создание и подача на рассмотрение модулей (или изменений в них)[1]

Если вы разработали код для взаимодействия с каким-то устройством (например, с LCD-дисплеем или каким-то аппаратным модулем), было бы здорово, если бы вы также создали и подали на рассмотрение JavaScript-модуль (библиотеку), которой могли бы воспользоваться другие люди при помощи команды вроде require("libname").

  • Создайте аккаунт в GitHub.
  • Зайдите сюда и кликните на кнопку Fork справа вверху. В результате на вашем GitHub-аккаунте появится полная копия всей документации этого репозитория.
  • Кликните на папку «devices», затем на Add file > Create new file справа вверху.
  • Назовите свой модуль в честь устройства, для которого разработан ваш код (но постарайтесь, чтобы название было как можно короче – как «PCD8544» для чипа, управляющего работой LCD-дисплея Nokia), а в конце добавьте «.js». В результате у вас должно получиться что-то вроде «MOD123.js».
* Скопируйте в этот файл вот этот шаблон:
/* Copyright (c) 2014 Ваше имя. 
   Информацию о лицензии скопируйте из файла LICENSE. */
/*
Краткое описание вашего модуля...
*/

var C = {
  MY : 0x001,          // описание
  PRIVATE : 0x001,     // описание
  CONSTANTS : 0x00423  // описание
};

function MOD123(pin1,pin2) {
  this.pin1 = pin1;
  this.pin2 = pin2;
}

/** Здесь будут «публичные» константы */
MOD123.prototype.C = {
  MY : 0x013,         // описание
  PUBLIC : 0x0541,    // описание
  CONSTANTS : 0x023   // описание
};

/** Большинство комментариев должны стоять вне функций... */
MOD123.prototype.foo = function() {
  // вы можете использовать C.PRIVATE
  // или this.C.PUBLIC
};

/** Большинство комментариев должны стоять вне функций... */
MOD123.prototype.bar = function() {
};

/** Это «экспортированная» функция, 
    так что вы можете использовать её при помощи  
    `require('MOD123.js').connect(pin1,pin2)` */
exports.connect = function (pin1, pin2) {
  return new MOD123(pin1, pin2);
};

Чтобы протестировать свой модуль, скопируйте его полностью в правую часть Web IDE, но в самом верху у него должна быть строчка var exports={};. А внизу (там, где используете модуль) напишите var exports={} вместо require('MOD123').myfunction().

В качестве примера можете взглянуть на уже готовые модули (некоторые из них шаблону выше не следуют). Вот пара важных вещей, которые помогут сделать ваш модуль эффективнее:

  • После загрузки модуля Espruino выполняет файл в его собственной области видимости, а затем сохраняет переменные и функции, которые были заданы в этой области видимости, в кэш модулей.
  • Все функции и переменные, которые были заданы в корневой области видимости, будут общими и не будут дублироваться, если модуль будет использован в коде дважды. Но если вы зададите функцию внутри другой функции (например, внутри функции exports.myfunction) то эта функция будет создаваться снова при каждом вызове функции exports.myfunction.
  • Большинство пользователей используют require() и в этом случае Web IDE загрузит минимизированную версию модуля. Это значит, что...
    • ...все непубличные константы и функции будут минифицированы, если в этом будет смысл. Это сэкономит место и сделает библиотеку быстрее.
    • ...все комментарии будут удалены.
  • Даже если пользователь не использует минимизированную версию (возможно, он скопировал на карту Micro-SD полную версию или поменял настройки Web IDE):
    • Espruino сохранит содержимое функций полностью (включая комментарии), но комментарии, находящиеся за пределами объявления функции, места занимать не будут.
  • Кликните на кнопку Commit new file внизу. Если вы захотите что-то поменять, вы всегда сможете снова кликнуть на этот файл, а затем кликнуть на иконку с карандашом справа вверху, чтобы начать редактирование этого файла.
  • Теперь нам нужно создать маленький файл для документации, чтобы ваш модуль смогли найти другие пользователи. Добавьте ещё один файл и назовите его «MOD123.md».
  • Скопируйте в него шаблон ниже (первым словом в строчке KEYWORDS всегда должно стоять слово Module).
<!--- Copyright (c) 2014 Ваше имя.
      Информацию о лицензии смотрите в файле LICENSE. --> 
      Формальное название вашего модуля.
=====================

* KEYWORDS: Module,список,слов,для,поиска,модуля,разделенных,запятой

Немного информации о модуле. Здесь можно, например, 
немного описать устройство, для которого разработан этот модуль.

Устройство можно подключить следующим образом:

| Контакт    | Espruino |
| Устройства |          |
| ---------- | -------- |
| 1 (GND)    | GND      |
| 2 (VCC)    | 3.3      |
| 3 (SIGIN)  | A0       |
| 4 (SIGNOUT)| A1       |

Как использовать мой модуль:

```
  var foo = require("MOD123").connect(A0,A1);
  foo.usingFoo();
```

Описание модуля нужно будет отформатировать при помощи языка разметки Markdown. Примеры его использования ищите здесь или у других модулей на GitHub. Кроме того, если у вашего модуля больше одной функции, вы можете добавить в него APPEND_JSDOC. Это просканирует указанный JS-файл (то есть в данном случае – MOD123.js) на предмет экспортированных функций и комментариев в формате /** ... */, чтобы потом добавить их в ваш модуль в качестве справочной информации. 

Reference
---------

* APPEND_JSDOC: MOD123.js

Кроме того, вы можете добавить в него APPEND_USES. Теперь если у какого-то руководства вверху будет написано USES: MOD123, то он будет указан на странице вашего модуля: 

Using
-----
  • APPEND_USES: MOD123
  • Вот и всё! Теперь кликните на кнопку Commit New File внизу.
  • При необходимости внесите нужные правки и изменения, а затем кликните на кнопку Pull Request справа вверху.
  • Проверьте, правильные ли файлы там показаны (это должны быть файлы, которые мы создали в этом руководстве), а затем кликните на Create pull request.
  • Откроется новая страница, где надо будет ввести название и описание пулл-реквеста. Указав их, нажмите на Create pull request. Готово! Теперь мы можем увидеть внесённые вами изменения и добавить их ко всем остальным.

См.также

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

  1. ↑ www.espruino.com - Writing and Submitting Modules (or changes)
Партнерские ресурсы
Криптовалюты
Магазины
Хостинг
Разное
Справочник по 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:Примеры/Создание_и_подача_на_рассмотрение_модулей_(или_изменений_в_них)&oldid=7739022