Espruino:Примеры/Добавление приложения в загрузчик приложений Bangle.js

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску

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


Добавление приложения в загрузчик приложений Bangle.js[1]

Если у вас есть приложение (созданное, например, с помощью этого руководства), то вы, возможно, захотите добавить его в загрузчик приложений Bangle.js, чтобы его могли установить и другие пользователи.

Примечание: Чтобы максимально упростить ситуацию с копирайтом, GitHub-репозиторий BangleApps и весь код в нём распространяются по лицензии MIT. Поэтому, предлагая своё приложение, вы автоматически соглашаетесь, что ваш код тоже будет распространяться по лицензии MIT, так что вам нужно будет убедиться, что в вашем приложении нет никаких данных или изображений, защищённых копирайтом (на которые у вас нет права бесплатного распространения).

Создание ответвления (форка)

Первый шаг – это создание «форка» загрузчика приложений Bangle.js (т.е. создание вашей собственной копии):

  • Перейдите в GitHub-репозиторий BangleApps.
  • Зарегистрируйтесь/залогиньтесь в GitHub (справа вверху страницы).
  • Кликните на кнопку Fork справа вверху репозитория BangleApps.

Включение GitHub Pages

Теперь давайте включим сервис GitHub Pages, который позволит просматривать и использовать вашу собственную копию репозитория:

  • Нажмите на Settings вверху.
  • Пролистайте вниз до пункта GitHub Pages.
  • В меню Source выберите пункт master и нажмите на кнопку Save.
  • Страница обновится, а в разделе GitHub Pages появится вот такое сообщение:
Your site is ready to be published at https://ваш_никнейм.github.io/BangleApps
Примечание

Вы можете хостить загрузчик приложений сами, но это нужно делать с помощью HTTPS-сервера (не HTTP), чтобы мог работать Web Bluetooth.

Добавление своего приложения

Если вы прошли руководство «Первое приложение для Bangle.js (таймер)», то у вас уже должно быть приложение с ID «timer», так что давайте им и воспользуемся. Нам нужно создать новую папку с таким же названием в папке «apps».

Вот пример того, как может выглядеть эта папка.

Опытные GitHub-разработчики наверняка знают, как клонировать репозиторий на свой локальный компьютер, но если вы не хотите или не знаете, как это сделать, то это можно сделать и онлайн:

  • Перейдите в свой репозиторий BangleApps по ссылке https://github.com/ваш_никнейм/BangleApps
  • Кликните на папку «apps»
  • Кликните на кнопку Add file, а потом на Create new file
  • Теперь впишите в названии файла «timer/app.js» и скопируйте JavaScript-код приложения в окно редактора. Если кода нет, и вы просто хотите попробовать что-нибудь, напишите:
E.showMessage("My\nSimple\nApp","My App")
  • Теперь кликните на кнопку Commit new file
  • Откроется новое окно с папкой «BangleApps/apps/timer». Давайте добавим иконку приложения
  • В руководстве «Первое приложение для Bangle.js (таймер)» мы загрузили для иконки 48-пиксельный PNG-файл, так что давайте им и воспользуемся
  • Переименуйте этот файл на ПК на «app.js» (в GitHub нет возможности переименовывать файлы)
  • Будучи в папке «BangleApps/apps/timer», кликните на Add file > Upload files, загрузите файл и кликните на Commit Changes

Теперь нам надо загрузить иконку, но в том виде, который будет понятен Bangle.js.

  • Откройте конвертер изображений
  • Нажмите на кнопку «Выберите файл» и загрузите файл «app.png»
  • Поставьте галочки рядом с пунктами Use Compression и Transparency
  • Задайте в меню Colours пункт 4 bit Mac Palette и посмотрите на превью. Если вам не понравилась эта цветовая палитра, выберите пункт 8 bit Web Palette (но, если возможно, лучше остановиться на 4 bit Mac Palette, т.к. эта настройка требует в два раза меньше памяти, чем 8 bit Web Palette)
  • В меню Output As выберите настройку Image String
  • Внизу должен появиться текст вроде var img = E.toArrayBuffer(atob("...")). Выделите и скопируйте только часть с E.toArrayBuffer(atob("...")) – без части var img =.
  • Вернитесь на GitHub в папку «BangleApps/apps/timer» и создайте новый файл под названием «app-icon.js» с кодом E.toArrayBuffer(atob("...")), который скопировали выше, а затем кликните на Commit new File.

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

Наконец, давайте добавим описание нашего приложения. Например, такое.

  • Вернитесь в корневую директорию репозитория BangleApps
  • Кликните на файл «apps.json»
  • Кликните на маленькую иконку с карандашом справа вверху – это включит режим редактирования
  • Теперь пролистайте вниз и добавьте в конец файла следующее:
},
{ "id": "timer",
  "name": "My Timer App",
  "shortName":"My Timer",
  "icon": "app.png",
  "version":"0.01",
  "description": "Это описание для моего приложения-таймера",
  "tags": "",
  "storage": [
    {"name":"timer.app.js","url":"app.js"},
    {"name":"timer.img","url":"app-icon.js","evaluate":true}
  ]
}
]

Более подробно о формате этого файла читайте тут.

Очень важно добавить дополнительную запятую в конце последнего элемента JSON-кода (как в первой строчке выше).

  • Теперь кликните на Commit Changes и готово!
Примечание

Если вы работаете с локальной копией GitHub-репозитория, то можете запустить файл «bin/sanitycheck.js», который быстро проверит описание вашего приложения на предмет того, всё ли там нормально (иконки, код и т.д.).

Использование нового приложения

  • Вернитесь в свой репозиторий BangleApps по ссылке https://ваш_никнейм.github.io/BangleApps (не забудьте поменять фрагмент «ваш_никнейм» на свой никнейм в GitHub)
  • Там должно быть приложение My Timer App – кликните на кнопку загрузки рядом с ним
  • Теперь нажмите на кнопку BTN3 на Bangle.js и откройте лаунчер – ваше приложение будет там!
Примечание

Если загрузчик приложений не работает, то скорее всего это из-за ошибки в файле «apps.json», который вы редактировали ранее.

Документация о вашем приложении

У нашего приложения небольшое описание, но многим другим приложениям требуется чуть побольше документации о том, как их использовать.

Чтобы добавить эту документацию так, чтобы её потом было легко и просто найти из загрузчика приложений, нужно создать файл «README.md» (файл на языке Markdown) в папке нашего приложения.

Затем добавляем в JSON-файле описания вот это: 

"readme":"README.md",

Теперь, когда кто-то найдёт ваше приложение в загрузчике приложений, он также увидит гиперссылку «Read more...» («Читать далее...»). Если кликнуть на неё, это откроет окно с вашей документацией.

Внесение изменений

Если вы хотите внести в своё приложение какие-то изменения, просто отредактируйте нужные файлы в своём репозитории. Кроме того, если вы предлагаете своё приложение для широкой публики, предполагается, что вы также добавите чейнжлог-файл, чтобы зрители могли видеть, что изменилось в вашем приложении.

  • Добавьте файл под названием «BangleApps/apps/timer/ChangeLog» – он должен выглядеть примерно так:
0.01: Новое приложение!
0.02: Исправлен баг с отсчётом
0.03: Добавлен более красивый текст!

Отредактируйте строчку "version":"0.01" в файле «apps.json», чтобы она соответствовала последнему номеру версии в файле-чейнжлоге.

Как предложить своё приложение на главный загрузчик приложений Bangle.js

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

Разработчики Bangle.js пишут, что стараются принимать все присылаемые им приложения, но это по очевидным причинам не касается неисправных приложений и приложений, которые не подходят для детей. Но ваши приложения всегда можно будет загрузить из вашего собственного загрузчика приложений по ссылке https://ваш_никнейм.github.io/BangleApps.

  • В своей копии главного репозитория (https://github.com/ваш_никнейм/BangleApps) кликните на Pull request справа вверху
  • Пролистайте вниз, чтобы посмотреть, какие файлы были изменены и добавлены, и убедитесь, что всё нормально
  • Если всё в порядке, кликайте на Create Pull Request
  • На следующей странице напишите короткий заголовок в поле Title и описание на вкладке Write, чтобы разработчики примерно понимали, что это за приложение
  • Кликните на Create pull request

Это создаст запрос на публикацию вашего приложения и покажет жёлтый текст «Some checks haven’t completed yet» («Некоторые проверки ещё не выполнены»).

Разработчики применяют ко всем предлагаемым приложениям скрипт «bin/sanitycheck.js» при помощи Travis CI. Это помогает быстро оценить, всё ли в порядке, но не сможет выловить баги в вашем приложении, а лишь убедится, что загрузчик приложений работает нормально.

Через какое-то время жёлтый текст должен смениться на зелёный текст «All checks have passed» («Все проверки пройдены») или «Checks failed» («Проверки не пройдены»). Если проверки не были пройдены, ваше приложение в таком состоянии одобрено не будет, но вы всегда можете кликнуть на Show all Checks > Details и посмотреть, какие были допущены ошибки. Если вы исправите их в своём репозитории, статус проверок будет обновлён.

Дополнительные материалы

По этой ссылке можно найти большое количество руководств по Bangle.js.

Пример формата приложений и JSON-файлов смотрите в README-файле загрузчика приложений Bangle.js.

См.также

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

  1. ↑ www.espruino.com - Adding an app to the Bangle.js App Loader
Партнерские ресурсы
Криптовалюты
Магазины
Хостинг
Разное
Справочник по 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:Примеры/Добавление_приложения_в_загрузчик_приложений_Bangle.js&oldid=7737204