Compare commits

..
30 Commits
Author SHA1 Message Date
Stasia Michalska 79c64e5777 Bump version 2026-02-19 03:41:51 +01:00
Stasia Michalska 8ba0a2caee Add gabbro support to clay 2026-02-19 03:41:51 +01:00
clach04 904d6bca55 Update readme to clarify slider fractional values
Previous text implied negative values not allowed (they are allowed) and it wasn't clear that fractional numbers were the topic until the example.
2026-02-09 08:53:44 +01:00
Stasia Michalska 94f4770731 Bump to 1.0.6 2025-12-21 20:13:06 +01:00
Jay Michalska fa0e243bf1 Merge pull request #2 from pebble-dev/dependabot/npm_and_yarn/require-from-string-2.0.2
Bump require-from-string from 1.2.1 to 2.0.2
2025-12-21 19:38:52 +01:00
Jay Michalska c7bb67f2ef Merge pull request #5 from pebble-dev/dependabot/npm_and_yarn/autoprefixer-10.4.23
Bump autoprefixer from 10.4.22 to 10.4.23
2025-12-21 19:38:36 +01:00
Jay Michalska 2d1a355b23 Merge pull request #3 from pebble-dev/dependabot/npm_and_yarn/multi-f4700cd87e
Bump braces and watchify
2025-12-21 19:38:17 +01:00
dependabot[bot] b606e8f87a Bump autoprefixer from 10.4.22 to 10.4.23
Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 10.4.22 to 10.4.23.
- [Release notes](https://github.com/postcss/autoprefixer/releases)
- [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/autoprefixer/compare/10.4.22...10.4.23)

---
updated-dependencies:
- dependency-name: autoprefixer
  dependency-version: 10.4.23
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-21 17:50:39 +00:00
dependabot[bot] 98fc4a41eb Bump braces and watchify
Bumps [braces](https://github.com/micromatch/braces) to 3.0.3 and updates ancestor dependency [watchify](https://github.com/browserify/watchify). These dependencies need to be updated together.


Updates `braces` from 2.3.2 to 3.0.3
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/commits/3.0.3)

Updates `watchify` from 3.11.1 to 3.11.1
- [Release notes](https://github.com/browserify/watchify/releases)
- [Changelog](https://github.com/browserify/watchify/blob/master/CHANGELOG.md)
- [Commits](https://github.com/browserify/watchify/compare/v3.11.1...v3.11.1)

---
updated-dependencies:
- dependency-name: braces
  dependency-version: 3.0.3
  dependency-type: indirect
- dependency-name: watchify
  dependency-version: 3.11.1
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-21 17:50:36 +00:00
dependabot[bot] 7836694b53 Bump require-from-string from 1.2.1 to 2.0.2
Bumps [require-from-string](https://github.com/floatdrop/require-from-string) from 1.2.1 to 2.0.2.
- [Commits](https://github.com/floatdrop/require-from-string/compare/v1.2.1...v2.0.2)

---
updated-dependencies:
- dependency-name: require-from-string
  dependency-version: 2.0.2
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-21 17:50:32 +00:00
Jay Michalska 0866527ea0 Merge pull request #1 from pebble-dev/update
Revive the repository
2025-12-21 18:49:32 +01:00
Stasia Michalska c1b87080f1 Rename to @rebble/clay and pebble-dev/clay 2025-12-21 18:48:49 +01:00
Stasia Michalska b2e9ed2392 Commit the package-lock 2025-12-21 18:11:07 +01:00
Stasia Michalska 75548a1c04 Update dependencies 2025-12-21 18:11:07 +01:00
Stasia Michalska 900b03de1d Ignore dist and all waf build locks 2025-12-21 18:11:07 +01:00
Stasia Michalska cc0e88598f Replace travis with github actions 2025-12-21 18:11:07 +01:00
Stasia Michalska 078186cd25 Add flint support 2025-12-13 00:53:33 +01:00
Stasia Michalska b55a4c6c61 Fix tests 2025-12-12 23:58:27 +01:00
Stasia Michalska 4dad63ea90 Update to newer gulp version 2025-12-12 16:46:12 +01:00
Stasia Michalska 6335169e9a Remove node-sass requirement that crashes the build 2025-11-15 21:07:43 +01:00
Keegan Lillo 1bf6db0809 Release v1.0.4 (#156) 2016-11-21 12:09:01 -08:00
Keegan Lillo 4b53d920c7 #77 - Add docs for setSettings() (#155) 2016-11-21 11:32:53 -08:00
Keegan Lillo fa3406a809 #151 - Fix incorrect value being set when defaultValue is falsey (#152) 2016-10-21 12:11:12 -07:00
Yohan Robert 46c0adb62c #77 - Allow claySettings to be modified from app.js (#150)
* .setSettings(key, value) to set a single setting
* .setSettings(object) to set multiple settings at once
2016-10-21 10:36:55 -07:00
Keegan Lillo d18170337d Release/v1.0.3 (#148) 2016-10-18 09:47:32 -07:00
Keegan Lillo 9c7238d578 #124/get items by group (#147)
* Add getItemsByGroup function

* Update test

* update readme

* Update README for submit button

* Update docs with ID prop for button and submit components
2016-10-18 09:40:32 -07:00
Keegan Lillo 1a63761e43 #141 - Use index.js not app.js in docs (#142) 2016-09-29 01:15:45 -07:00
Ben Combee 9c6bb48c7a fix copy-paste error with messageKey in ClayItem description (#138) 2016-09-14 23:42:36 -07:00
Jon Barlow 2173ad7c71 Add some note about Rocky.js (#134) 2016-08-17 13:51:22 +01:00
Keegan Lillo b8db6c6a90 Direct pebble.js users to v0.1.7 and fix typos 2016-07-11 11:29:06 -07:00
43 changed files with 14309 additions and 793 deletions
+11
View File
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
+29
View File
@@ -0,0 +1,29 @@
name: Build CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
container:
image: ghcr.io/pebble-dev/pebbleos-docker:v1
steps:
- uses: actions/checkout@v4
- name: Set up uv
uses: astral-sh/setup-uv@v7
- run: uv tool install pebble-tool
- run: npm install
- run: npm run build
- run: pebble build
- uses: actions/upload-artifact@v4
with:
name: clay
path: dist.zip
+23
View File
@@ -0,0 +1,23 @@
name: Lint CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: 'npm'
- run: npm install
- run: npm run lint
+28
View File
@@ -0,0 +1,28 @@
name: Node.js Package
on:
release:
types: [created]
permissions:
id-token: write
contents: read
jobs:
publish-npm:
runs-on: ubuntu-latest
container:
image: ghcr.io/pebble-dev/pebbleos-docker:v1
steps:
- uses: actions/checkout@v4
- name: Set up uv
uses: astral-sh/setup-uv@v7
- run: uv tool install pebble-tool
- run: npm install
- run: npm run build
- run: pebble build
- name: Update npm
run: npm install -g npm@latest
- run: npm publish
+34
View File
@@ -0,0 +1,34 @@
name: Test CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: 'npm'
- name: Setup Chrome
uses: browser-actions/setup-chrome@v2
id: setup-chrome
with:
install-dependencies: true
- run: npm install
- run: npm run build
- name: Run headless test
uses: coactions/setup-xvfb@v1
with:
run: npm run test-travis
env:
CHROME_BIN: ${{ steps.setup-chrome.outputs.chrome-path }}
+2 -1
View File
@@ -3,7 +3,7 @@
# node-waf configuration
.lock-wscript
/.lock-waf_darwin_build
/.lock-waf_*_build
# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
@@ -13,4 +13,5 @@
/tmp/
/src/js/index.js
/dist.zip
/dist/
/build/
+1 -1
View File
@@ -1,4 +1,4 @@
# We ignore everything except for what is actually used by the pebble tool.
# We ignore everying except for what is actually used by the pebble tool.
/**/*
!/dist.zip
!/src/**/*
-12
View File
@@ -1,12 +0,0 @@
language: node_js
sudo: false
node_js:
- '4'
before_script:
# Needed to include Chrome in Travis for karma tests
- export CHROME_BIN=chromium-browser
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
script: 'npm run test-travis'
-33
View File
@@ -1,33 +0,0 @@
cmake_minimum_required (VERSION 3.2)
project (test-project)
set(CMAKE_C_FLAGS "-std=c11 -mthumb -ffunction-sections -g -fno-diagnostics-show-caret -D_REENT_SMALL=1 -Wall -Wextra -Werror -Wpointer-arith -Wno-unused-parameter -Wno-missing-field-initializers -Wno-error=unused-function -Wno-error=unused-variable -Wno-error=unused-parameter -Wno-error=unused-but-set-variable -Wno-packed-bitfield-compat -mcpu=cortex-m3 -Os -Werror=return-type")
file(GLOB_RECURSE src "src/c/*")
file(GLOB_RECURSE include "include/*")
file(GLOB_RECURSE build "build/basalt/*.c")
set(SOURCES
${src}
${build}
${include}
)
set(INCLUDES
~/Library/Application\ Support/Pebble\ SDK/SDKs/current/sdk-core/pebble/basalt/include
./node_modules/pebble-events/dist/include
./node_modules/@smallstoneapps/linked-list/dist/include
./node_modules/@keegan-stoneware/simple-dict/dist/include
./node_modules/@keegan-stoneware/simple-app-message/dist/include
./build/include
./build
./include
)
add_definitions(-DPEBBLE)
add_definitions(-DPBL_COLOR)
include_directories(${INCLUDES})
add_executable(app ${SOURCES})
+6 -6
View File
@@ -4,7 +4,7 @@ Thanks for checking out Clay. We accept pull requests from anybody, however we a
that you follow some conventions when contributing to Clay.
We have set up a
[piece-of-cake](https://github.com/pebble/clay/issues?q=is%3Aopen+is%3Aissue+label%3Apiece-of-cake)
[piece-of-cake](https://github.com/pebble-dev/clay/issues?q=is%3Aopen+is%3Aissue+label%3Apiece-of-cake)
label in GitHub issues for bugs/features that are easy to implement. These issues are
a great place to start for people that are new to the codebase.
@@ -13,7 +13,7 @@ a great place to start for people that are new to the codebase.
- [Node](https://nodejs.org) (4.0 and later)
- [Google Chrome](www.google.com/chrome) (To run tests)
- [Pebble SDK](https://developer.pebble.com/sdk/) (optional)
- [Pebble SDK](https://developer.rebble.io/sdk/) (optional)
## Getting Started
@@ -192,7 +192,7 @@ adhering to the style guide.
## Getting Help
- Chat to us in the `#clay` channel on slack. http://slack.pbldev.io/
- Visit the [Pebble Forums](https://forums.pebble.com/)
- Tweet at [@pebbledev](https://twitter.com/pebbledev)
- More options at https://developer.pebble.com/community/online/
- Chat to us in the `#app-dev` channel on Discord. https://discordapp.com/invite/aRUAYFN
- Visit the [Rebble Forums](https://forum.rebble.io/)
- Skeet at [@rebble.io](https://bsky.app/profile/rebble.io)
- More options at https://developer.rebble.io/community/online/
+52 -100
View File
@@ -1,51 +1,30 @@
# Clay - Experimental
Welcome to the experimental branch of Clay. Expect this branch to be buggy, with incorrect docs, and with APIs that often change. DO NOT use this branch for your own projets but feel free to provide feedback via the Clay channel at http://discord.gg/aRUAYFN
---
# Clay
Clay is a JavaScript library that makes it easy to add offline configuration pages to your Pebble apps. All you need to get started is a couple lines of JavaScript and a JSON file; no servers or HTML required.
Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `messageKey` as defined in `package.json` (or PebbleKit JS Message Keys on CloudPebble), and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually).
Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events traditionally implemented by developers to relay configuration settings to the watch side of the app. This step is not required when using Clay, since each config item is given the same `messageKey` as defined in `package.json`, and is automatically transmitted once the configuration page is submitted by the user. Developers can override this behavior by [handling the events manually](#handling-the-showconfiguration-and-webviewclosed-events-manually).
Clay is distributed as a [Pebble package](https://developer.pebble.com/guides/pebble-packages/) so it is super easy to include in your project. If you are upgrading from v0.1.x of Clay you need to follow the [migration guide](#migrating-from-v01x-to-v1x) before you can get started.
Clay is distributed as a [Pebble package](https://developer.rebble.io/guides/pebble-packages/) so it is super easy to include in your project. If you are upgrading from v0.1.x of Clay you need to follow the [migration guide](#migrating-from-v01x-to-v1x) before you can get started.
If you would like to contribute to Clay, check out the [contributing guide.](CONTRIBUTING.md)
# Getting Started (SDK 3.13 or higher)
1. Run `pebble package install pebble-clay` to install the package in your project
1. Run `pebble package install @rebble/clay` to install the package in your project
2. Create a JSON file called `config.json` and place it in your `src/js` directory.
3. In order for JSON files to work you may need to change a line in your `wscript` from `ctx.pbl_bundle(binaries=binaries, js=ctx.path.ant_glob('src/js/**/*.js'))` to `ctx.pbl_bundle(binaries=binaries, js=ctx.path.ant_glob(['src/js/**/*.js', 'src/js/**/*.json']))`.
4. Your `app.js` file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `app.js` file:
4. Your `index.js` (`app.js` in SDK 3) file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `index.js` file:
```javascript
var Clay = require('pebble-clay');
var Clay = require('@rebble/clay');
var clayConfig = require('./config.json');
var clay = new Clay(clayConfig);
```
5. Ensure `pebble.enableMultiJS` is set to true in your `package.json`.
6. Next is the fun part - creating your config page. Edit your `config.json` file to build a layout of elements as described in the sections below.
7. Make sure you have defined all of your `messageKeys` in your `package.json`. More info on how that works [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
7. Make sure you have defined all of your `messageKeys` in your `package.json`. More info on how that works [here.](https://developer.rebble.io/guides/communication/using-pebblekit-js/#defining-keys)
# Getting Started (CloudPebble)
1. Ensure `JS Handling` is set to `CommonJS-style` in your project settings.
2. Under `Dependencies` in the project navigation, enter `pebble-clay` as the `Package Name` and `^1.0.0` for the `Version`. You may use any specific version you like, however using `^1.0.0` will ensure you receive all minor version updates.
4. Create a JavaScript file called `config.js` with the following content. This will act as your config's root array element, from which the rest of the page is built up:
```javascript
module.exports = [];
```
5. Your `app.js` file needs to `require` clay and your config file, then be initialized. Clay will by default automatically handle the 'showConfiguration' and 'webviewclosed' events. Copy and paste the following into the top of your `app.js` file:
```javascript
var Clay = require('pebble-clay');
var clayConfig = require('./config');
var clay = new Clay(clayConfig);
```
6. Next is the fun part - creating your config page. Edit your `config.js` file to build a layout of elements as described in the sections below.
7. Make sure you have defined all of your message keys using `Automatic assignment` in your project settings. More info on how that works [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
# Getting Started (Rocky.js)
If you are using [Rocky.js](https://developer.rebble.io/docs/rockyjs/) and would like to use Clay, please be aware that this is currently unsupported. It is possible to install the Clay package and override the 'showConfiguration' and 'webviewclosed' events and handle them manually, but Rocky.js does not currently support persistent storage, so the settings must be loaded from the phone each time. You can find an example of using Clay with Rocky.js [here](https://github.com/orviwan/rocky-leco-clay).
# Creating Your Config File
@@ -125,11 +104,12 @@ Headings can be used in anywhere and can have their size adjusted to suit the co
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `heading`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| defaultValue | string/HTML | The heading's text. |
| size | int | Defaults to `4`. An integer from 1 to 6 where 1 is the largest size and 6 is the smallest. (represents HTML `<h1>`, `<h2>`, `<h3>`, etc). |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -156,10 +136,11 @@ Text is used to provide descriptions of sections or to explain complex parts of
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `text`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| defaultValue | string/HTML | The content of the text element. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -184,13 +165,14 @@ Standard text input field.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `input`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. |
| defaultValue | string | The default value of the input field. |
| description | string | Optional sub-text to include below the component |
| attributes | object | An object containing HTML attributes to set on the input field. Set `type` to values such as "email", "time", "date" etc to adjust the behavior of the component. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -222,12 +204,13 @@ Switch for a single item.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `toggle`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. |
| defaultValue | int\|boolean | The default value of the toggle. Defaults to `false` if not specified. |
| description | string | Optional sub-text to include below the component |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -254,13 +237,14 @@ A dropdown menu containing multiple options.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `select`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. |
| defaultValue | string | The default value of the dropdown menu. Must match a value in the `options` array. |
| description | string | Optional sub-text to include below the component |
| options | array of objects | The options you want to appear in the dropdown menu. Each option is an object with a `label` and `value` property. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -352,23 +336,24 @@ A color picker that allows users to choose a color from the ones that are compat
The color picker will automatically show a different layout depending on the watch connected:
- Aplite (Firmware 2.x) - Black and white
- Aplite (Firmware 3.x) - Black and white. Will also include gray (`#AAAAAA`) if `allowGray` is set to `true`
- Basalt/chalk - The 64 colors compatible with color Pebble smartwatches.
- Aplite/Diorite/Flint (Firmware 3.x) - Black and white. Will also include gray (`#AAAAAA`) if `allowGray` is set to `true`
- Basalt/Chalk/Emery/Gabbro - The 64 colors compatible with color Pebble smartwatches.
##### Properties
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `color`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. |
| defaultValue | string OR int | The default color. One of the [64 colors](https://developer.pebble.com/guides/tools-and-resources/color-picker/) compatible with Pebble smartwatches. Always use the uncorrected value even if `sunlight` is true. The component will do the conversion internally. |
| defaultValue | string OR int | The default color. One of the [64 colors](https://developer.rebble.io/guides/tools-and-resources/color-picker/) compatible with Pebble smartwatches. Always use the uncorrected value even if `sunlight` is true. The component will do the conversion internally. |
| description | string | Optional sub-text to include below the component |
| sunlight | boolean | Use the color-corrected sunlight color palette if `true`, else the uncorrected version. Defaults to `true` if not specified. |
| layout | string OR array | Optional. Use a custom layout for the color picker. Defaults to automatically choosing the most appropriate layout for the connected watch. The layout is represented by a two dimensional array. Use `false` to insert blank spaces. You may also use one of the preset layouts by setting `layout` to: `"COLOR"`, `"GRAY"` or `"BLACK_WHITE"` |
| allowGray | boolean | Optional. Set this to `true` to include gray (`#AAAAAA`) in the color picker for aplite running on firmware 3 and above. This is optional because only a subset of the drawing operations support gray on aplite. Defaults to `false` |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -426,13 +411,14 @@ A list of options allowing the user can only choose one option to submit.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `radiogroup`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. |
| label | string | The label that should appear next to this item. |
| defaultValue | string | The default selected item. Must match a value in the `options` array. |
| description | string | Optional sub-text to include below the component |
| options | array of objects | The options you want to appear in the radio group. Each option is an object with a `label` and `value` property. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -471,13 +457,14 @@ A list of options where a user may choose more than one option to submit.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `checkboxgroup`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemsById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. **NOTE:** The checkboxgroup component will expect you to have defined a `messageKey` in your `package.json` using array syntax. In the example below, the matching entry in the `package.json` would be `favorite_food[3]`. In CloudPebble, you must use `Automatic assignment` for message keys and the `Key Array Length` must match the number of options in the checkboxgroup |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| messageKey | string (unique) | The AppMessage key matching the `messageKey` item defined in your `package.json`. Set this to a unique string to allow this item to be looked up using `Clay.getItemsByMessageKey()` in your custom function. You must set this if you wish for the value of this item to be persisted after the user closes the config page. **NOTE:** The checkboxgroup component will expect you to have defined a `messageKey` in your `package.json` using array syntax. In the example below, the matching entry in the `package.json` would be `favorite_food[3]`. |
| label | string | The label that should appear next to this item. |
| defaultValue | array of booleans | The default selected items. |
| description | string | Optional sub-text to include below the component |
| options | array of strings | The labels for each checkbox you want to appear in the checkbox group. |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -504,10 +491,12 @@ In the above example, Sushi and Burgers will be selected by default.
| Property | Type | Description |
|----------|------|-------------|
| type | string | Set to `button`. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| defaultValue | string | The text displayed on the button. |
| primary | boolean | If `true` the button will be orange, if `false`, the button will be gray (defaults to `false`)|
| description | string | Optional sub-text to include below the component |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -527,7 +516,7 @@ In the above example, Sushi and Burgers will be selected by default.
The range slider is used to allow users to select numbers between two values.
**NOTE** If you set the `step` property to anything less than `1`,
**NOTE** If you set the `step` property to a fractional value,
it will multiply the final value sent to the watch by 10 to the power of the number of decimal places in the value of `step`.
Eg: If you set the `step` to `0.25` and the slider has value of `34.5`, the watch will receive `3450`.
The reason why this is necessary, is because you can not send floats to the watch via `Pebble.sendAppMessage()`.
@@ -546,6 +535,7 @@ you must just remember to divide the received value on the watch accordingly.
| step | number | The multiple of the values allowed to be set on the slider. The slider will snap to these values. This value also determines the precision used when the value is sent to the watch. Defaults to 1 |
| description | string | Optional sub-text to include below the component |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -576,7 +566,9 @@ The submit button for the page. You **MUST** include this component somewhere in
|----------|------|-------------|
| type | string | Set to `submit`. |
| defaultValue | string | The text displayed on the button. |
| id | string (unique) | Set this to a unique string to allow this item to be looked up using `Clay.getItemById()` in your [custom function](#custom-function). |
| capabilities | array | Array of features that the connected watch must have for this item to be present |
| group | string | Set this to allow this item, along with other items sharing the same group to be looked up using `Clay.getItemsByGroup()` in your [custom function](#custom-function) |
##### Example
@@ -591,7 +583,7 @@ The submit button for the page. You **MUST** include this component somewhere in
### Message keys and array syntax
Clay supports (and requires in some cases) the use of array syntax for message keys. Also known as `Automatic assignment` in CloudPebble. More info [here.](https://developer.pebble.com/guides/communication/using-pebblekit-js/#defining-keys)
Clay supports (and requires in some cases) the use of array syntax for message keys. More info [here.](https://developer.rebble.io/guides/communication/using-pebblekit-js/#defining-keys)
You can assign any component that does not return an array to a particular position in your message key. This is done by appending the position (zero indexed) wrapped in brackets to the end of the `messageKey` property. Do **NOT** include any spaces in your `messageKey`.
@@ -671,7 +663,9 @@ Below is the full list of capabilities
| PLATFORM_BASALT | Running on Pebble Time/Pebble Time Steel. |
| PLATFORM_CHALK | Running on Pebble Time Round. |
| PLATFORM_DIORITE | Running on Pebble 2 |
| PLATFORM_EMERY | Running on Time 2. |
| PLATFORM_EMERY | Running on Core Time 2. |
| PLATFORM_FLINT | Running on Core 2 Duo. |
| PLATFORM_GABBRO | Running on Core Time Round 2 |
| BW | Running on hardware that supports only black and white. |
| COLOR | Running on hardware that supports 64 colors. |
| MICROPHONE | Running on hardware that includes a microphone. |
@@ -793,7 +787,7 @@ Clay will by default, automatically handle the 'showConfiguration' and 'webviewc
Example:
```javascript
var Clay = require('pebble-clay');
var Clay = require('@rebble/clay');
var clayConfig = require('./config');
var clayConfigAplite = require('./config-aplite');
var clay = new Clay(clayConfig, null, { autoHandleEvents: false });
@@ -827,51 +821,6 @@ Pebble.addEventListener('webviewclosed', function(e) {
});
```
## Clay and Pebble.js
If you are using [Pebble.js](https://developer.pebble.com/docs/pebblejs/) and would like to use Clay, There are some extra steps to follow:
1. Remove all your `Settings.config` calls. Clay will handle the settings from now on.
2. Use the example below to modify your `app.js`. Notice that `autoHandleEvents` is set to `false` in the Clay constructor.:
```javascript
var Settings = require('settings');
var Clay = require('pebble-clay');
var clayConfig = require('./config');
var clay = new Clay(clayConfig, null, {autoHandleEvents: false});
Pebble.addEventListener('showConfiguration', function(e) {
Pebble.openURL(clay.generateUrl());
});
Pebble.addEventListener('webviewclosed', function(e) {
if (e && !e.response) {
return;
}
var dict = clay.getSettings(e.response);
// Save the Clay settings to the Settings module.
Settings.option(dict);
});
```
### Caveats
Clay treats colors as numbers. You will need to convert these numbers to CSS colors before they can be used by Pebble.js. Use the function below to convert the colors.
```javascript
function cssColor(color) {
color = color.toString(16);
while (color.length < 6) {
color = '0' + color;
}
return '#' + color;
}
// Example usage with default:
cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
```
## Clay API (app.js)
### `Clay([Array] config, [function] customFn, [object] options)`
@@ -893,9 +842,9 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
| `.config` | Array | Copy of the config passed to the constructor and used for generating the page. |
| `.customFn` | Function | Reference to the custom function passed to the constructor. **WARNING** this is a direct reference, not a copy of the custom function so any modification you make to it, will be reflected on the original as well |
| `.meta` | Object | Contains information about the current user and watch. **WARNING** This will only be populated in the `showConfiguration` event handler. (See example above) |
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getActiveWatchInfo). |
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getAccountToken). |
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getWatchToken). |
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getActiveWatchInfo). |
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getAccountToken). |
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getWatchToken). |
| `.meta.userData` | Any | A deep copy of the arbitrary data provided in the `options.userData`. Defaults to an empty object |
| `.version` | String | The version of Clay currently being used. |
@@ -907,6 +856,8 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000);
| `.registerComponent( [ClayComponent] component )` <br> Registers a custom component. | `void`. |
| `.generateUrl()` | `string` - The URL to open with `Pebble.openURL()` to use the Clay-generated config page. |
| `.getSettings( [object] response, [boolean] convert=true)` <br> `response` - the response object provided to the "webviewclosed" event <br> `convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `messageKey`, where the key is the `messageKey` and the value is the chosen value of that item. <br><br>This method will do some conversions depending on the type of the setting. Arrays will use message key array syntax to make the values of each item in the array available as individual message keys. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. If the value is a number or an array of numbers and the optional property: "precision" is the power of precision (value * 10 ^ precision) and then floored. Eg: `1.4567` with a precision set to `3` will become `1456`. Pass `false` as the second parameter to disable this behavior. See the example below for how this all works |
| `.setSettings( [string] key, [*] value )` <br> `key` - The key for the setting you want to set. <br> `value` - The value of the setting you want to set. | `void` |
| `.setSettings( [object] settings )` <br> `settings` - An object of key/value pairs that you would like to update the settings with. eg `{ user_name: 'Emily', show_animations: true }` | `void` |
#### `.getSettings()` Example
@@ -958,7 +909,7 @@ Make sure to always wait for the config page to be built before manipulating ite
##### app.js
```javascript
var Clay = require('pebble-clay');
var Clay = require('@rebble/clay');
var clayConfig = require('./config');
var customClay = require('./custom-clay');
var userData = {token: 'abc123'}
@@ -1021,9 +972,9 @@ This is the main way of talking to your generated config page. An instance of th
| `.EVENTS.AFTER_DESTROY` | String | Dispatched after destroying the page. |
| `.config` | Array | Reference to the config passed to the constructor and used for generating the page. |
| `.meta` | Object | Contains information about the current user and watch |
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getActiveWatchInfo). |
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getAccountToken). |
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getWatchToken). |
| `.meta.activeWatchInfo` | watchinfo\|null | An object containing information on the currently connected Pebble smartwatch or null if unavailable. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getActiveWatchInfo). |
| `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getAccountToken). |
| `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.rebble.io/docs/js/Pebble/#getWatchToken). |
| `.meta.userData` | Any | The data passed in the `options.userData` of the [Clay constructor.](#clayarray-config-function-customfn-object-options) |
@@ -1035,6 +986,7 @@ This is the main way of talking to your generated config page. An instance of th
| `.getItemByMessageKey( [string] messageKey )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `messageKey`, otherwise `undefined`. |
| `.getItemById( [string] id )` | `ConfigItem\|undefined` - a single `ConfigItem` that has the provided `id`, otherwise `undefined`. |
| `.getItemsByType( [string] type )` | `Array.<ConfigItem>` - an array of config items that match the provided `type`. |
| `.getItemsByGroup( [string] group )` | `Array.<ConfigItem>` - an array of config items that match the provided `group`. |
| `.serialize()` | `Object` - an object representing all items with an `messageKey` where the key is the `messageKey` and the value is an object with the `value` property set to the result of running `.get()` on the Clay item. If the Clay item has a `precision` property set, it is included in the object |
| `.build()` <br> Builds the config page. Will dispatch the `BEFORE_BUILD` event prior to building the page, then the `AFTER_BUILD` event once it is complete. If the config page has already been built, then the `ClayConfig.destroy()` method will be executed prior to building the page again. | `ClayConfig` |
| `.destroy()` <br> Destroys the config page. Will dispatch the `BEFORE_DESTROY` event prior to destroying the page, then the `AFTER_DESTROY` event once it is complete. This method wipes the config page completely, including all existing items. You will need to make sure that you re-attach your event handlers for any items that are replaced | `ClayConfig` |
@@ -1052,7 +1004,7 @@ This is the main way of talking to your generated config page. An instance of th
| Property | Type | Description |
|----------|------|-------------|
| `.id` | String | The ID of the item if provided in the config. |
| `.messageKey` | String | The ID of the item if provided in the config. |
| `.messageKey` | String | The messageKey of the item if provided in the config. |
| `.config` | Object | Reference to the config passed to the constructer. |
| `$element` | $Minified | A Minified list representing the root HTML element of the config item. |
| `$manipulatorTarget` | $Minified | A Minified list representing the HTML element with **data-manipulator-target** set. This is generally pointing to the main `<input>` element and will be used for binding events. |
@@ -1095,7 +1047,7 @@ Components are simple objects with the following properties.
Components must be registered before the config page is built. The easiest way to do this is in your `app.js` after you have initialized Clay:
```javascript
var Clay = require('pebble-clay');
var Clay = require('@rebble/clay');
var clayConfig = require('./config.json');
var clay = new Clay(clayConfig);
-10
View File
@@ -1,10 +0,0 @@
# Ignore build generated files
build/
dist/
dist.zip
# Ignore waf lock file
.lock-waf*
# Ignore installed node modules
node_modules/
-30
View File
@@ -1,30 +0,0 @@
cmake_minimum_required (VERSION 3.2)
project (test-project)
set(CMAKE_C_FLAGS "-std=c11 -mthumb -ffunction-sections -g -fno-diagnostics-show-caret -D_REENT_SMALL=1 -Wall -Wextra -Werror -Wpointer-arith -Wno-unused-parameter -Wno-missing-field-initializers -Wno-error=unused-function -Wno-error=unused-variable -Wno-error=unused-parameter -Wno-error=unused-but-set-variable -Wno-packed-bitfield-compat -mcpu=cortex-m3 -Os -Werror=return-type")
file(GLOB_RECURSE src "src/*")
file(GLOB_RECURSE build "build/basalt/*.c")
set(SOURCES
${src}
${build}
)
set(INCLUDES
~/Library/Application\ Support/Pebble\ SDK/SDKs/current/sdk-core/pebble/basalt/include
./node_modules/pebble-events/dist/include
./node_modules/@keegan-stoneware/simple-dict/dist/include
./node_modules/pebble-clay/dist/include
./build/include
./build
./include
)
add_definitions(-DPEBBLE)
add_definitions(-DPBL_COLOR)
include_directories(${INCLUDES})
add_executable(app ${SOURCES})
-35
View File
@@ -1,35 +0,0 @@
{
"name": "clay-test",
"author": "MakeAwesomeHappen",
"version": "1.0.0",
"keywords": [
"pebble-app"
],
"scripts": {
"build": "./scripts/build.sh"
},
"private": true,
"dependencies": {
"pebble-clay": "../"
},
"pebble": {
"displayName": "clay-test",
"uuid": "3fff53d2-1b59-48d7-8187-0c2f3674c32d",
"sdkVersion": "3",
"enableMultiJS": true,
"targetPlatforms": [
"aplite",
"basalt",
"chalk",
"diorite",
"emery"
],
"watchapp": {
"watchface": false
},
"messageKeys": [],
"resources": {
"media": []
}
}
}
-9
View File
@@ -1,9 +0,0 @@
#!/bin/bash
test_app_folder_name="clay-test"
if [ "$(basename $(pwd))" != "$test_app_folder_name" ]; then
echo "Must be executed from $test_app_folder_name folder"
exit
fi
pebble clean && cd .. && npm run pebble-build || { cd $test_app_folder_name && exit; } && cd $test_app_folder_name && pebble build
-133
View File
@@ -1,133 +0,0 @@
#include <inttypes.h>
#include <pebble.h>
#include <pebble-clay/clay.h>
#define CLAY_INBOX_SIZE (64)
#define CHAR_SIZE (10)
#define ARRAY_SIZE (3)
#define INT_DEFAULT (0xff0000)
#define CHAR_DEFAULT ("default")
#define BOOL_DEFAULT (false)
static Window *s_window;
static int s_background_color = INT_DEFAULT;
static char s_label_char_value[CHAR_SIZE] = CHAR_DEFAULT;
static bool s_label_bool_value = BOOL_DEFAULT;
static bool s_label_array_value_raw[ARRAY_SIZE] = {true, false, true};
static char s_label_array_value[ARRAY_SIZE + 1] = {'0', '0', '0'};
static TextLayer *s_label_char;
static TextLayer *s_label_bool;
static TextLayer *s_label_array;
static void prv_update_display(Layer *layer, GContext *ctx) {
graphics_context_set_fill_color(ctx, GColorFromHEX(s_background_color));
graphics_fill_rect(ctx, layer_get_bounds(layer), 0, GCornerNone);
text_layer_set_text(s_label_char, s_label_char_value);
text_layer_set_text(s_label_bool, s_label_bool_value ? "true" : "false");
for (int i = 0; i < ARRAY_SIZE; ++i) {
if (s_label_array_value_raw[i]) {
s_label_array_value[i] = '1';
}
}
text_layer_set_text(s_label_array, s_label_array_value);
}
static void prv_clay_updated_handler(void *context) {
clay_get_int("test_int", &s_background_color);
clay_get_bool("test_bool", &s_label_bool_value);
clay_get_string("test_char", s_label_char_value, CHAR_SIZE);
layer_mark_dirty(window_get_root_layer(s_window));
}
static void prv_window_unload(Window *window) {
layer_destroy(text_layer_get_layer(s_label_char));
layer_destroy(text_layer_get_layer(s_label_bool));
layer_destroy(text_layer_get_layer(s_label_array));
window_destroy(window);
}
static void prv_select_click_handler(ClickRecognizerRef recognizer, void *context) {
s_background_color = 0x00ff00;
clay_set_int("test_int", &s_background_color);
s_label_bool_value = true;
clay_set_bool("test_bool", &s_label_bool_value);
strcpy(s_label_char_value, "internal");
clay_set_string("test_char", s_label_char_value);
layer_mark_dirty(window_get_root_layer(s_window));
}
static void prv_up_click_handler(ClickRecognizerRef recognizer, void *context) {
s_background_color = INT_DEFAULT;
clay_set_int("test_int", &s_background_color);
s_label_bool_value = BOOL_DEFAULT;
clay_set_bool("test_bool", &s_label_bool_value);
strcpy(s_label_char_value, CHAR_DEFAULT);
clay_set_string("test_char", s_label_char_value);
layer_mark_dirty(window_get_root_layer(s_window));
}
static void prv_click_config_provider(void *context) {
window_single_click_subscribe(BUTTON_ID_SELECT, prv_select_click_handler);
window_single_click_subscribe(BUTTON_ID_UP, prv_up_click_handler);
}
static void prv_window_load(Window *window) {
Layer *window_layer = window_get_root_layer(s_window);
layer_set_update_proc(window_layer, prv_update_display);
GRect bounds = layer_get_bounds(window_layer);
s_label_char = text_layer_create(GRect(0, bounds.size.h / 4, bounds.size.w, 30));
text_layer_set_text_alignment(s_label_char, GTextAlignmentCenter);
text_layer_set_background_color(s_label_char, GColorClear);
layer_add_child(window_layer, text_layer_get_layer(s_label_char));
s_label_bool = text_layer_create(GRect(0, bounds.size.h / 2, bounds.size.w, 30));
text_layer_set_text_alignment(s_label_bool, GTextAlignmentCenter);
text_layer_set_background_color(s_label_bool, GColorClear);
layer_add_child(window_layer, text_layer_get_layer(s_label_bool));
s_label_array = text_layer_create(GRect(0, 3 * (bounds.size.h / 4), bounds.size.w, 30));
text_layer_set_text_alignment(s_label_array, GTextAlignmentCenter);
text_layer_set_background_color(s_label_array, GColorClear);
layer_add_child(window_layer, text_layer_get_layer(s_label_array));
prv_clay_updated_handler(NULL);
}
static void prv_init(void) {
const ClayCallbacks clay_callbacks = {
.settings_updated = prv_clay_updated_handler,
};
clay_register_callbacks(&clay_callbacks, NULL);
clay_init(CLAY_INBOX_SIZE, true);
s_window = window_create();
window_set_window_handlers(s_window, (WindowHandlers) {
.load = prv_window_load,
.unload = prv_window_unload,
});
window_set_click_config_provider(s_window, prv_click_config_provider);
window_stack_push(s_window, true);
}
int main(void) {
prv_init();
app_event_loop();
}
-40
View File
@@ -1,40 +0,0 @@
'use strict';
var Clay = require('pebble-clay');
var clay = new Clay({
config: [
{
type: 'section',
items: [
{
label: 'int',
type: 'color',
messageKey: 'test_int'
},
{
label: 'char',
type: 'input',
messageKey: 'test_char'
},
{
label: 'bool',
type: 'toggle',
messageKey: 'test_bool'
},
{
label: 'array',
type: 'checkboxgroup',
messageKey: 'test_array',
options: ['one', 'two', 'three']
},
{
type: 'submit',
defaultValue: 'submit'
}
]
}
],
closedCallback: function(response) {
console.log('closedcallback: arguments' + JSON.stringify(arguments));
}
});
-59
View File
@@ -1,59 +0,0 @@
#
# This file is the default set of rules to compile a Pebble application.
#
# Feel free to customize this to your needs.
#
import os.path
import shutil
import waflib
top = '.'
out = 'build'
def options(ctx):
ctx.load('pebble_sdk')
def distclean(ctx):
node_modules_dir = ctx.path.find_node('node_modules')
if node_modules_dir:
shutil.rmtree(node_modules_dir.abspath())
waflib.Scripting.distclean(ctx)
def configure(ctx):
"""
This method is used to configure your build. ctx.load(`pebble_sdk`) automatically configures
a build for each valid platform in `targetPlatforms`. Platform-specific configuration: add your
change after calling ctx.load('pebble_sdk') and make sure to set the correct environment first.
Universal configuration: add your change prior to calling ctx.load('pebble_sdk').
"""
ctx.load('pebble_sdk')
def build(ctx):
ctx.load('pebble_sdk')
build_worker = os.path.exists('worker_src')
binaries = []
cached_env = ctx.env
for platform in ctx.env.TARGET_PLATFORMS:
ctx.env = ctx.all_envs[platform]
ctx.set_group(ctx.env.PLATFORM_NAME)
app_elf = '{}/pebble-app.elf'.format(ctx.env.BUILD_DIR)
ctx.pbl_program(source=ctx.path.ant_glob('src/**/*.c'), target=app_elf)
if build_worker:
worker_elf = '{}/pebble-worker.elf'.format(ctx.env.BUILD_DIR)
binaries.append({'platform': platform, 'app_elf': app_elf, 'worker_elf': worker_elf})
ctx.pbl_worker(source=ctx.path.ant_glob('worker_src/**/*.c'), target=worker_elf)
else:
binaries.append({'platform': platform, 'app_elf': app_elf})
ctx.env = cached_env
ctx.set_group('bundle')
ctx.pbl_bundle(binaries=binaries,
js=ctx.path.ant_glob(['src/js/**/*.js', 'src/js/**/*.json']),
js_entry_file='src/js/app.js')
-7
View File
@@ -12,13 +12,6 @@ module.exports = [
"type": "text",
"defaultValue": "This is config 2"
},
{
type: 'thing',
defaultValue: {
en_US: 'foo',
fr_FR: 'bar'
}
},
{
"type": "section",
"items": [
+4 -4
View File
@@ -41,7 +41,7 @@ module.exports = [
"messageKey": "email",
"defaultValue": "",
"label": "Input Field",
"description": "{{i18n.foo}} This is a description for the input component. " +
"description": "This is a description for the input component. " +
"You can add <strong>html</strong> in here too.",
"attributes": {
"placeholder": "Placeholder set with attributes"
@@ -64,11 +64,11 @@ module.exports = [
{
"type": "slider",
"messageKey": "slider",
"defaultValue": 15,
"defaultValue": 0,
"label": "Slider",
"description": "This is the description for the slider",
"min": 10,
"max": 20,
"min": 0,
"max": 30,
"step": 0.25
},
{
+51 -31
View File
@@ -8,11 +8,10 @@ var stringify = require('stringify');
var del = require('del');
var inline = require('gulp-inline');
var htmlmin = require('gulp-htmlmin');
var sass = require('gulp-sass');
var sass = require('gulp-sass')(require('sass'));
var sourceMaps = require('gulp-sourcemaps');
var autoprefixer = require('gulp-autoprefixer');
var uglify = require('gulp-uglify');
var sassify = require('sassify');
var autoprefixify = require('./src/scripts/vendor/autoprefixify');
var insert = require('gulp-insert');
var clayPackage = require('./package.json');
@@ -22,22 +21,13 @@ var sassIncludePaths = [].concat(
'src/styles'
);
var sassifyOptions = {
base64Encode: false,
sourceMap: false,
sourceMapEmbed: false,
sourceMapContents: false,
outputStyle: 'compact',
includePaths: sassIncludePaths
};
var autoprefixerOptions = {
browsers: ['Android 4', 'iOS 8'],
cascade: false
};
var stringifyOptions = ['.html', '.tpl'];
var versionMessage = '/* Clay - https://github.com/pebble/clay - Version: ' +
var stringifyOptions = ['.html', '.tpl', '.css'];
var versionMessage = '/* Clay - https://github.com/pebble-dev/clay - Version: ' +
clayPackage.version +
' - Build Date: ' + new Date().toISOString() + ' */\n';
@@ -45,29 +35,44 @@ gulp.task('clean-js', function() {
return del(['tmp/config-page.js']);
});
gulp.task('js', ['clean-js'], function() {
/**
* @returns {string}
*/
function taskJs() {
return browserify('src/scripts/config-page.js', { debug: true })
.transform('deamdify')
.bundle()
.pipe(source('config-page.js'))
.pipe(gulp.dest('./tmp/'));
});
}
gulp.task('js', gulp.series('clean-js', taskJs));
gulp.task('clean-sass', function() {
return del(['tmp/config-page.scss']);
});
gulp.task('sass', ['clean-sass'], function() {
gulp.src('./src/styles/config-page.scss')
/**
* @returns {string}
*/
function taskSass() {
return gulp.src(['./src/styles/config-page.scss',
'./src/styles/clay/components/*.scss'])
.pipe(sourceMaps.init())
.pipe(sass({
includePaths: sassIncludePaths
loadPaths: sassIncludePaths
}).on('error', sass.logError))
.pipe(autoprefixer(autoprefixerOptions))
.pipe(sourceMaps.write('./'))
.pipe(gulp.dest('tmp'));
});
}
gulp.task('inlineHtml', ['js', 'sass'], function() {
gulp.task('sass', gulp.series('clean-sass', taskSass));
/**
* @returns {string}
*/
function taskInlineHtml() {
return gulp.src('src/config-page.html')
.pipe(inline())
.pipe(htmlmin({
@@ -80,17 +85,21 @@ gulp.task('inlineHtml', ['js', 'sass'], function() {
minifyCSS: true
}))
.pipe(gulp.dest('tmp/'));
});
}
gulp.task('clay', ['inlineHtml'], function() {
gulp.task('inlineHtml', gulp.series('js', 'sass', taskInlineHtml));
/**
* @returns {string}
*/
function taskClay() {
return browserify('index.js', {
debug: false,
standalone: clayPackage.name
})
.transform('deamdify')
.transform(stringify(stringifyOptions))
.transform(sassify, sassifyOptions)
.transform(autoprefixify, autoprefixerOptions)
// .transform(autoprefixify, autoprefixerOptions)
.require(require.resolve('./index'), {expose: clayPackage.name})
.exclude('message_keys')
.bundle()
@@ -101,24 +110,35 @@ gulp.task('clay', ['inlineHtml'], function() {
}))
.pipe(insert.prepend(versionMessage))
.pipe(gulp.dest('./src/js'));
});
}
gulp.task('dev-js', ['js', 'sass'], function() {
gulp.task('clay', gulp.series('inlineHtml', taskClay));
/**
* @returns {string}
*/
function taskDevJs() {
return browserify('dev/dev.js', { debug: true })
.transform(stringify(stringifyOptions))
.transform('deamdify')
.transform(sassify, sassifyOptions)
.transform(autoprefixify, autoprefixerOptions)
.ignore('message_keys')
.bundle()
.pipe(source('dev.js'))
.pipe(gulp.dest('./tmp/'));
});
}
gulp.task('default', ['clay']);
gulp.task('dev-js', gulp.series('js', 'sass', taskDevJs));
gulp.task('dev', ['dev-js'], function() {
gulp.task('default', gulp.series('clay'));
/**
* @returns {string}
*/
function taskDev() {
gulp.watch('src/styles/**/*.scss', ['sass']);
gulp.watch(['src/scripts/**/*.js', 'src/templates/**/*.tpl'], ['js']);
gulp.watch(['src/**', 'dev/**/*.js'], ['dev-js']);
});
}
gulp.task('dev', gulp.series('dev-js', taskDev));
-31
View File
@@ -1,31 +0,0 @@
#pragma once
#include <@keegan-stoneware/simple-app-message/simple-app-message.h>
typedef void (*ClayUpdatedCallback)(void *context);
typedef struct ClayCallbacks {
ClayUpdatedCallback settings_updated;
} ClayCallbacks;
void clay_init(uint32_t inbox_size, bool open_app_message);
void clay_register_callbacks(const ClayCallbacks *callbacks, void *context);
bool clay_remove(const char *key);
bool clay_set_bool(const char *key, bool *value);
bool clay_set_data(const char *key, const void *value, size_t size);
bool clay_set_int(const char *key, int *value);
bool clay_set_string(const char *key, const char *value);
bool clay_get_bool(const char *key, bool *value_out);
bool clay_get_data(const char *key, void *value_out, size_t size);
bool clay_get_int(const char *key, int *value_out);
bool clay_get_string(const char *key, char *value_out, size_t size);
+90 -56
View File
@@ -5,30 +5,34 @@ var toSource = require('tosource');
var standardComponents = require('./src/scripts/components');
var deepcopy = require('deepcopy/build/deepcopy.min');
var version = require('./package.json').version;
var simpleAppMessage = require('@keegan-stoneware/simple-app-message');
var utils = require('./src/scripts/lib/utils');
var messageKeys = require('message_keys');
/**
* @param {Object} options - Clay options
* @param {Array} [options.config] - The config
* @param {function} [options.openCallback]
* @param {function} [options.closedCallback]
* @param {Object} [options.locales]
* @param {function} [options.customFunction] - Custom code to run from the config
* page. Will run with the ClayConfig instance as context
* @param {Array} config - the Clay config
* @param {function} [customFn] - Custom code to run from the config page. Will run
* with the ClayConfig instance as context
* @param {Object} [options] - Additional options to pass to Clay
* @param {boolean} [options.autoHandleEvents=true] - If false, Clay will not
* automatically handle the 'showConfiguration' and 'webviewclosed' events
* @param {*} [options.userData={}] - Arbitrary data to pass to the config page. Will
* be available as `clayConfig.meta.userData`
* @constructor
*/
function Clay(options) {
function Clay(config, customFn, options) {
var self = this;
if (!options) {
utils.throw('You must define options');
if (!Array.isArray(config)) {
throw new Error('config must be an Array');
}
options = deepcopy(options);
if (customFn && typeof customFn !== 'function') {
throw new Error('customFn must be a function or "null"');
}
self.config = options.config;
self.customFn = options.customFn || function() {};
options = options || {};
self.config = deepcopy(config);
self.customFn = customFn || function() {};
self.components = {};
self.meta = {
activeWatchInfo: null,
@@ -53,30 +57,30 @@ function Clay(options) {
}
// Let Clay handle all the magic
Pebble.addEventListener('showConfiguration', function() {
_populateMeta();
Pebble.openURL(self.generateUrl());
});
if (options.autoHandleEvents !== false && typeof Pebble !== 'undefined') {
Pebble.addEventListener('webviewclosed', function(e) {
if (!e || !e.response) { return; }
var settings = self.getSettings(e.response, false);
if (options.closedCallback) {
options.closedCallback(settings);
}
simpleAppMessage.send('CLAY', settings, function(response) {
if (response.error) {
utils.log('Failed to send config data!');
utils.log(response.error);
} else {
utils.log('Sent config data to Pebble');
}
Pebble.addEventListener('showConfiguration', function() {
_populateMeta();
Pebble.openURL(self.generateUrl());
});
});
Pebble.addEventListener('webviewclosed', function(e) {
if (!e || !e.response) { return; }
// Send settings to Pebble watchapp
Pebble.sendAppMessage(self.getSettings(e.response), function() {
console.log('Sent config data to Pebble');
}, function(error) {
console.log('Failed to send config data!');
console.log(JSON.stringify(error));
});
});
} else if (typeof Pebble !== 'undefined') {
Pebble.addEventListener('ready', function() {
_populateMeta();
});
}
/**
* If this function returns true then the callback will be executed
@@ -191,10 +195,9 @@ Clay.prototype.getSettings = function(response, convert) {
try {
settings = JSON.parse(response);
} catch (e) {
utils.error('The provided response was not valid JSON');
throw new Error('The provided response was not valid JSON');
}
// @todo do something with the persist flag here
// flatten the settings for localStorage
var settingsStorage = {};
Object.keys(settings).forEach(function(key) {
@@ -207,7 +210,40 @@ Clay.prototype.getSettings = function(response, convert) {
localStorage.setItem('clay-settings', JSON.stringify(settingsStorage));
return convert === false ? settingsStorage : Clay.prepareSettingsForAppMessage(settings);
return convert === false ? settings : Clay.prepareSettingsForAppMessage(settings);
};
/**
* Updates the settings with the given value(s).
*
* @signature `clay.setSettings(key, value)`
* @param {String} key - The property to set.
* @param {*} value - the value assigned to _key_.
* @return {undefined}
*
* @signature `clay.setSettings(settings)`
* @param {Object} settings - an object containing the key/value pairs to be set.
* @return {undefined}
*/
Clay.prototype.setSettings = function(key, value) {
var settingsStorage = {};
try {
settingsStorage = JSON.parse(localStorage.getItem('clay-settings')) || {};
} catch (e) {
console.error(e.toString());
}
if (typeof key === 'object') {
var settings = key;
Object.keys(settings).forEach(function(key) {
settingsStorage[key] = settings[key];
});
} else {
settingsStorage[key] = value;
}
localStorage.setItem('clay-settings', JSON.stringify(settingsStorage));
};
/**
@@ -318,26 +354,24 @@ Clay.prepareSettingsForAppMessage = function(settings) {
var result = {};
Object.keys(flatSettings).forEach(function(key) {
// var messageKey = messageKeys[key];
// var settingArr = Clay.prepareForAppMessage(flatSettings[key]);
// settingArr = Array.isArray(settingArr) ? settingArr : [settingArr];
//
// settingArr.forEach(function(setting, index) {
// result[messageKey + index] = setting;
// });
var messageKey = messageKeys[key];
var settingArr = Clay.prepareForAppMessage(flatSettings[key]);
settingArr = Array.isArray(settingArr) ? settingArr : [settingArr];
result[key] = Clay.prepareForAppMessage(flatSettings[key]);
settingArr.forEach(function(setting, index) {
result[messageKey + index] = setting;
});
});
// validate the settings
// Object.keys(result).forEach(function(key) {
// if (Array.isArray(result[key])) {
// throw new Error('Clay does not support 2 dimensional arrays for item ' +
// 'values. Make sure you are not attempting to use array ' +
// 'syntax (eg: "myMessageKey[2]") in the messageKey for ' +
// 'components that return an array, such as a checkboxgroup');
// }
// });
Object.keys(result).forEach(function(key) {
if (Array.isArray(result[key])) {
throw new Error('Clay does not support 2 dimensional arrays for item ' +
'values. Make sure you are not attempting to use array ' +
'syntax (eg: "myMessageKey[2]") in the messageKey for ' +
'components that return an array, such as a checkboxgroup');
}
});
return result;
};
+13727
View File
File diff suppressed because it is too large Load Diff
+27 -28
View File
@@ -1,9 +1,9 @@
{
"name": "pebble-clay",
"version": "1.0.2",
"name": "@rebble/clay",
"version": "1.0.7",
"description": "Pebble Config Framework",
"scripts": {
"test-travis": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run --browsers chromeTravisCI && ./node_modules/.bin/eslint ./",
"test-travis": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run --browsers chromeTravisCI",
"test-debug": "(export DEBUG=true && ./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --no-single-run)",
"test": "./node_modules/.bin/gulp && ./node_modules/.bin/karma start ./test/karma.conf.js --single-run",
"lint": "./node_modules/.bin/eslint ./",
@@ -15,7 +15,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/pebble/clay.git"
"url": "git+https://github.com/pebble-dev/clay.git"
},
"keywords": [
"pebble",
@@ -26,7 +26,7 @@
"author": "Pebble Technology",
"license": "MIT",
"bugs": {
"url": "https://github.com/pebble/clay/issues"
"url": "https://github.com/pebble-dev/clay/issues"
},
"pebble": {
"projectType": "package",
@@ -36,7 +36,9 @@
"basalt",
"chalk",
"diorite",
"emery"
"emery",
"flint",
"gabbro"
],
"resources": {
"media": []
@@ -45,12 +47,12 @@
"configurable"
]
},
"homepage": "https://github.com/pebble/clay#readme",
"homepage": "https://github.com/pebble-dev/clay#readme",
"devDependencies": {
"autoprefixer": "^6.3.1",
"autoprefixer": "^10.4.23",
"bourbon": "^4.2.6",
"browserify": "^13.0.0",
"browserify-istanbul": "^0.2.1",
"browserify-istanbul": "^3.0.1",
"chai": "^3.4.1",
"deamdify": "^0.2.0",
"deepcopy": "^0.6.1",
@@ -58,36 +60,33 @@
"eslint": "^1.5.1",
"eslint-config-pebble": "^1.2.0",
"eslint-plugin-standard": "^1.3.1",
"gulp": "^3.9.0",
"gulp": "^5.0.1",
"gulp-autoprefixer": "^3.1.0",
"gulp-htmlmin": "^1.3.0",
"gulp-inline": "0.0.15",
"gulp-inline": "^0.1.3",
"gulp-insert": "^0.5.0",
"gulp-sass": "^2.1.1",
"gulp-sass": "^6.0.1",
"gulp-sourcemaps": "^1.6.0",
"gulp-uglify": "^1.5.2",
"joi": "^6.10.1",
"karma": "^0.13.19",
"karma-browserify": "^5.0.1",
"karma-chrome-launcher": "^0.2.2",
"karma-coverage": "^0.5.3",
"karma-mocha": "^0.2.1",
"karma-mocha-reporter": "^1.1.5",
"karma-source-map-support": "^1.1.0",
"karma": "^6.4.0",
"karma-browserify": "^8.1.0",
"karma-chrome-launcher": "^3.2.0",
"karma-coverage": "^2.2.1",
"karma-mocha": "^2.0.1",
"karma-mocha-reporter": "^2.2.5",
"karma-source-map-support": "^1.4.0",
"karma-threshold-reporter": "^0.1.15",
"mocha": "^2.3.4",
"postcss": "^5.0.14",
"require-from-string": "^1.1.0",
"sassify": "^0.9.1",
"mocha": "^11.7.5",
"postcss": "^8.5.6",
"require-from-string": "^2.0.2",
"sass": "^1.94.2",
"sinon": "^1.17.3",
"stringify": "^3.2.0",
"through": "^2.3.8",
"tosource": "^1.0.0",
"vinyl-buffer": "^1.0.0",
"vinyl-source-stream": "^1.1.0",
"watchify": "^3.7.0"
},
"dependencies": {
"@keegan-stoneware/simple-app-message": "^1.1.1"
"vinyl-source-stream": "^2.0.0",
"watchify": "^3.11.1"
}
}
-98
View File
@@ -1,98 +0,0 @@
#include "clay.h"
#include "hash.h"
#define SIMPLE_APP_MESSAGE_NAMESPACE ("CLAY")
static ClayCallbacks s_callbacks;
static uint32_t prv_hash_key(const char *key) {
return hash((uint8_t *)key, (uint32_t)strlen(key));
}
static bool prv_read(const char *key, void *value_out, size_t size) {
uint32_t persist_key = prv_hash_key(key);
int bytes_read = persist_read_data(persist_key, value_out, size);
return bytes_read >= 0 && (size_t)bytes_read == size;
}
static bool prv_write(const char *key, const void *data, size_t size) {
uint32_t persist_key = prv_hash_key(key);
int bytes_written = persist_write_data(persist_key, data, size);
return bytes_written >= 0 && (size_t)bytes_written == size;
}
static bool prv_simple_dict_foreach_callback(
const char *key, SimpleDictDataType type, const void *data, size_t size, void *context) {
return prv_write(key, data, size);
}
static void prv_simple_app_message_received_callback(const SimpleDict *message, void *context) {
if (!message) return;
simple_dict_foreach(message, prv_simple_dict_foreach_callback, NULL);
s_callbacks.settings_updated(context);
}
// ----- PUBLIC API -----
void clay_init(uint32_t inbox_size, bool open_app_message) {
const bool request_inbox_size_success = simple_app_message_request_inbox_size(inbox_size);
if (!request_inbox_size_success) {
APP_LOG(APP_LOG_LEVEL_ERROR, "CLAY: Failed to request inbox size of %d", (int)inbox_size);
return;
}
if (!open_app_message) return;
const AppMessageResult open_state = simple_app_message_open();
if (open_state != APP_MSG_OK) {
APP_LOG(APP_LOG_LEVEL_ERROR, "CLAY: Failed to open appmessage inbox. Code: %d", open_state);
}
}
void clay_register_callbacks(const ClayCallbacks *callbacks, void *context) {
s_callbacks = *callbacks;
const SimpleAppMessageCallbacks simple_app_message_callbacks = {
.message_received = prv_simple_app_message_received_callback,
};
const bool register_success = simple_app_message_register_callbacks(
SIMPLE_APP_MESSAGE_NAMESPACE, &simple_app_message_callbacks, context);
if (!register_success) {
APP_LOG(APP_LOG_LEVEL_ERROR, "CLAY: Failed to register callbacks for namespace %s",
SIMPLE_APP_MESSAGE_NAMESPACE);
}
}
bool clay_get_int(const char *key, int *value_out) {
return prv_read(key, value_out, sizeof(*value_out));
}
bool clay_get_bool(const char *key, bool *value_out) {
return prv_read(key, value_out, sizeof(*value_out));
}
bool clay_get_string(const char *key, char *value_out, size_t size) {
return prv_read(key, value_out, size);
}
bool clay_get_data(const char *key, void *value_out, size_t size) {
return prv_read(key, value_out, size);
}
bool clay_set_int(const char *key, int *value) {
return prv_write(key, value, sizeof(value));
}
bool clay_set_bool(const char *key, bool *value) {
return prv_write(key, value, sizeof(value));
}
bool clay_set_data(const char *key, const void *value, size_t size) {
return prv_write(key, value, size);
}
bool clay_set_string(const char *key, const char *value) {
return prv_write(key, value, strlen(value));
}
-21
View File
@@ -1,21 +0,0 @@
#include "hash.h"
#include <stdint.h>
// Based on DJB2 Hash
uint32_t hash(const uint8_t *bytes, const uint32_t length) {
uint32_t hash = 5381;
if (length == 0) {
return hash;
}
uint8_t c;
const uint8_t *last_byte = bytes + length;
while (bytes != last_byte) {
c = *bytes;
hash = ((hash << 5) + hash) + c;
bytes++;
}
return hash;
}
-5
View File
@@ -1,5 +0,0 @@
#pragma once
#include <stdint.h>
uint32_t hash(const uint8_t *bytes, const uint32_t length);
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'button',
template: require('../../templates/components/button.tpl'),
style: require('../../styles/clay/components/button.scss'),
style: require('../../../tmp/button.css'),
manipulator: 'button',
defaults: {
primary: false,
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'checkboxgroup',
template: require('../../templates/components/checkboxgroup.tpl'),
style: require('../../styles/clay/components/checkboxgroup.scss'),
style: require('../../../tmp/checkboxgroup.css'),
manipulator: 'checkboxgroup',
defaults: {
label: '',
+4 -3
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'color',
template: require('../../templates/components/color.tpl'),
style: require('../../styles/clay/components/color.scss'),
style: require('../../../tmp/color.css'),
manipulator: 'color',
defaults: {
label: '',
@@ -114,14 +114,15 @@ module.exports = {
* @returns {Array}
*/
function autoLayout() {
var bwWatches = ['aplite', 'diorite', 'flint'];
if (!clay.meta.activeWatchInfo ||
clay.meta.activeWatchInfo.firmware.major === 2 ||
['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
bwWatches.indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
!self.config.allowGray) {
return standardLayouts.BLACK_WHITE;
}
if (['aplite', 'diorite'].indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
if (bwWatches.indexOf(clay.meta.activeWatchInfo.platform) > -1 &&
self.config.allowGray) {
return standardLayouts.GRAY;
}
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'input',
template: require('../../templates/components/input.tpl'),
style: require('../../styles/clay/components/input.scss'),
style: require('../../../tmp/input.css'),
manipulator: 'val',
defaults: {
label: '',
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'radiogroup',
template: require('../../templates/components/radiogroup.tpl'),
style: require('../../styles/clay/components/radiogroup.scss'),
style: require('../../../tmp/radiogroup.css'),
manipulator: 'radiogroup',
defaults: {
label: '',
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'select',
template: require('../../templates/components/select.tpl'),
style: require('../../styles/clay/components/select.scss'),
style: require('../../../tmp/select.css'),
manipulator: 'val',
defaults: {
label: '',
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'slider',
template: require('../../templates/components/slider.tpl'),
style: require('../../styles/clay/components/slider.scss'),
style: require('../../../tmp/slider.css'),
manipulator: 'slider',
defaults: {
label: '',
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'submit',
template: require('../../templates/components/submit.tpl'),
style: require('../../styles/clay/components/submit.scss'),
style: require('../../../tmp/submit.css'),
manipulator: 'button',
defaults: {
attributes: {}
+1 -1
View File
@@ -3,7 +3,7 @@
module.exports = {
name: 'toggle',
template: require('../../templates/components/toggle.tpl'),
style: require('../../styles/clay/components/toggle.scss'),
style: require('../../../tmp/toggle.css'),
manipulator: 'checked',
defaults: {
label: '',
+13 -2
View File
@@ -86,9 +86,9 @@ function ClayConfig(settings, config, $rootContainer, meta) {
// set the value of the item via the manipulator to ensure consistency
var value = typeof _settings[_item.messageKey] !== 'undefined' ?
_settings[_item.messageKey] :
(_item.defaultValue || '');
_item.defaultValue;
clayItem.set(value);
clayItem.set(typeof value !== 'undefined' ? value : '');
$container.add(clayItem.$element);
}
@@ -182,6 +182,17 @@ function ClayConfig(settings, config, $rootContainer, meta) {
});
};
/**
* @param {string} group
* @returns {Array.<ClayItem>}
*/
self.getItemsByGroup = function(group) {
_checkBuilt('getItemsByGroup');
return _items.filter(function(item) {
return item.config.group === group;
});
};
/**
* @returns {Object}
*/
+22 -15
View File
@@ -44,18 +44,28 @@ module.exports.capabilityMap = {
minFwMajor: 0,
minFwMinor: 0
},
PLATFORM_FLINT: {
platforms: ['flint'],
minFwMajor: 0,
minFwMinor: 0
},
PLATFORM_GABBRO: {
platforms: ['gabbro'],
minFwMajor: 0,
minFwMinor: 0
},
BW: {
platforms: ['aplite', 'diorite'],
platforms: ['aplite', 'diorite', 'flint'],
minFwMajor: 0,
minFwMinor: 0
},
COLOR: {
platforms: ['basalt', 'chalk', 'emery'],
platforms: ['basalt', 'chalk', 'emery', 'gabbro'],
minFwMajor: 0,
minFwMinor: 0
},
MICROPHONE: {
platforms: ['basalt', 'chalk', 'diorite', 'emery'],
platforms: ['basalt', 'chalk', 'diorite', 'emery', 'flint', 'gabbro'],
minFwMajor: 0,
minFwMinor: 0
},
@@ -70,22 +80,22 @@ module.exports.capabilityMap = {
minFwMinor: 4
},
HEALTH: {
platforms: ['basalt', 'chalk', 'diorite', 'emery'],
platforms: ['basalt', 'chalk', 'diorite', 'emery', 'flint', 'gabbro'],
minFwMajor: 3,
minFwMinor: 10
},
RECT: {
platforms: ['aplite', 'basalt', 'diorite', 'emery'],
platforms: ['aplite', 'basalt', 'diorite', 'emery', 'flint'],
minFwMajor: 0,
minFwMinor: 0
},
ROUND: {
platforms: ['chalk'],
platforms: ['chalk', 'gabbro'],
minFwMajor: 0,
minFwMinor: 0
},
DISPLAY_144x168: {
platforms: ['aplite', 'basalt', 'diorite'],
platforms: ['aplite', 'basalt', 'diorite', 'flint'],
minFwMajor: 0,
minFwMinor: 0
},
@@ -98,6 +108,11 @@ module.exports.capabilityMap = {
platforms: ['emery'],
minFwMajor: 0,
minFwMinor: 0
},
DISPLAY_260x260_ROUND: {
platforms: ['gabbro'],
minFwMajor: 0,
minFwMinor: 0
}
};
@@ -133,11 +148,3 @@ module.exports.includesCapability = function(activeWatchInfo, capabilities) {
return result.indexOf(false) === -1;
};
module.exports.log = function(message) {
console.log('Clay: ' + JSON.stringify(message));
};
module.exports.throw = function(error) {
throw new Error('Clay: '+ error)
};
+1 -15
View File
@@ -24,24 +24,10 @@ module.exports = function(config) {
[
'stringify',
{
extensions: ['.html', '.tpl']
extensions: ['.html', '.tpl', '.css']
}
],
'deamdify',
[
'sassify',
{
base64Encode: false,
sourceMap: false,
sourceMapEmbed: false,
sourceMapContents: false,
outputStyle: 'compact',
includePaths: [].concat(
require('bourbon').includePaths,
'src/styles'
)
}
],
[
'browserify-istanbul',
{
+44
View File
@@ -456,6 +456,50 @@ describe('component - color', function() {
suffix: ''
}
});
testAutoLayout('emery', standardLayouts.COLOR, true, '', {
platform: 'emery',
model: 'qemu_platform_emery',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testAutoLayout('flint', standardLayouts.BLACK_WHITE, false, '', {
platform: 'flint',
model: 'qemu_platform_flint',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testAutoLayout('flint', standardLayouts.GRAY, true, '', {
platform: 'flint',
model: 'qemu_platform_flint',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testAutoLayout('gabbro', standardLayouts.COLOR, true, '', {
platform: 'gabbro',
model: 'qemu_platform_gabbro',
language: 'en_US',
firmware: {
major: 4,
minor: 0,
patch: 0,
suffix: ''
}
});
testCustomLayout();
testCustomLayout('COLOR');
+48
View File
@@ -386,6 +386,54 @@ describe('Clay', function() {
});
});
describe('.setSettings', function() {
it('it writes to localStorage when passing an object',
function() {
var clay = fixture.clay([]);
var settings = {
key1: 'value1',
key2: 'value2'
};
var expected = {
key1: 'value1',
key2: 'value2'
};
clay.setSettings(settings);
assert.equal(
localStorage.getItem('clay-settings'),
JSON.stringify(expected)
);
});
it('it writes to localStorage when passing a key and a value',
function() {
var clay = fixture.clay([]);
var expected = {
key1: 'value1',
key2: 'value2%7Dbreaks'
};
clay.setSettings('key1', 'value1');
clay.setSettings('key2', 'value2%7Dbreaks');
assert.equal(localStorage.getItem('clay-settings'),
JSON.stringify(expected)
);
});
it('doesn\'t throw and logs an error if settings in localStorage are broken',
function() {
var clay = fixture.clay([]);
var errorStub = sinon.stub(console, 'error');
localStorage.setItem('clay-settings', 'not valid JSON');
assert.doesNotThrow(function() {
clay.setSettings('key', 'value');
});
assert(errorStub.calledWithMatch(/SyntaxError/i));
errorStub.restore();
});
});
describe('.meta', function() {
var emptyMeta = {
activeWatchInfo: null,
+84
View File
@@ -15,6 +15,7 @@ describe('ClayConfig', function() {
'getItemByMessageKey',
'getItemById',
'getItemsByType',
'getItemsByGroup',
'serialize',
'registerComponent',
'build',
@@ -86,11 +87,14 @@ describe('ClayConfig', function() {
testCapabilities('aplite', 2, 9, ['DISPLAY_144x168'], 1);
testCapabilities('aplite', 2, 9, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('aplite', 2, 9, ['DISPLAY_200x228'], 0);
testCapabilities('aplite', 2, 9, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_APLITE'], 1);
testCapabilities('aplite', 2, 9, ['PLATFORM_BASALT'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_CHALK'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_DIORITE'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_EMERY'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_FLINT'], 0);
testCapabilities('aplite', 2, 9, ['PLATFORM_GABBRO'], 0);
testCapabilities('aplite', 3, 10, ['BW'], 1);
testCapabilities('aplite', 3, 10, ['COLOR'], 0);
@@ -106,11 +110,14 @@ describe('ClayConfig', function() {
testCapabilities('aplite', 3, 10, ['DISPLAY_144x168'], 1);
testCapabilities('aplite', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('aplite', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('aplite', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_APLITE'], 1);
testCapabilities('aplite', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('aplite', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('basalt', 3, 10, ['BW'], 0);
testCapabilities('basalt', 3, 10, ['COLOR'], 1);
@@ -128,11 +135,14 @@ describe('ClayConfig', function() {
testCapabilities('basalt', 3, 10, ['DISPLAY_144x168'], 1);
testCapabilities('basalt', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('basalt', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('basalt', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_BASALT'], 1);
testCapabilities('basalt', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('basalt', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('chalk', 3, 10, ['BW'], 0);
testCapabilities('chalk', 3, 10, ['COLOR'], 1);
@@ -150,11 +160,14 @@ describe('ClayConfig', function() {
testCapabilities('chalk', 3, 10, ['DISPLAY_144x168'], 0);
testCapabilities('chalk', 3, 10, ['DISPLAY_180x180_ROUND'], 1);
testCapabilities('chalk', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('chalk', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_CHALK'], 1);
testCapabilities('chalk', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('chalk', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('diorite', 3, 10, ['BW'], 1);
testCapabilities('diorite', 3, 10, ['COLOR'], 0);
@@ -172,11 +185,14 @@ describe('ClayConfig', function() {
testCapabilities('diorite', 3, 10, ['DISPLAY_144x168'], 1);
testCapabilities('diorite', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('diorite', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('diorite', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_DIORITE'], 1);
testCapabilities('diorite', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('diorite', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('emery', 3, 10, ['BW'], 0);
testCapabilities('emery', 3, 10, ['COLOR'], 1);
@@ -194,11 +210,59 @@ describe('ClayConfig', function() {
testCapabilities('emery', 3, 10, ['DISPLAY_144x168'], 0);
testCapabilities('emery', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('emery', 3, 10, ['DISPLAY_200x228'], 1);
testCapabilities('emery', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_EMERY'], 1);
testCapabilities('emery', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('emery', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('flint', 3, 10, ['BW'], 1);
testCapabilities('flint', 3, 10, ['COLOR'], 0);
testCapabilities('flint', 3, 10, ['MICROPHONE'], 1);
testCapabilities('flint', 3, 10, ['SMARTSTRAP'], 0);
testCapabilities('flint', 3, 4, ['SMARTSTRAP'], 0);
testCapabilities('flint', 3, 3, ['SMARTSTRAP'], 0);
testCapabilities('flint', 3, 10, ['SMARTSTRAP_POWER'], 0);
testCapabilities('flint', 3, 4, ['SMARTSTRAP_POWER'], 0);
testCapabilities('flint', 3, 3, ['SMARTSTRAP_POWER'], 0);
testCapabilities('flint', 3, 10, ['HEALTH'], 1);
testCapabilities('flint', 3, 9, ['HEALTH'], 0);
testCapabilities('flint', 3, 10, ['RECT'], 1);
testCapabilities('flint', 3, 10, ['ROUND'], 0);
testCapabilities('flint', 3, 10, ['DISPLAY_144x168'], 1);
testCapabilities('flint', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('flint', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('flint', 3, 10, ['DISPLAY_260x260_ROUND'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('flint', 3, 10, ['PLATFORM_FLINT'], 1);
testCapabilities('flint', 3, 10, ['PLATFORM_GABBRO'], 0);
testCapabilities('gabbro', 3, 10, ['BW'], 0);
testCapabilities('gabbro', 3, 10, ['COLOR'], 1);
testCapabilities('gabbro', 3, 10, ['MICROPHONE'], 1);
testCapabilities('gabbro', 3, 10, ['SMARTSTRAP'], 0);
testCapabilities('gabbro', 3, 10, ['SMARTSTRAP_POWER'], 0);
testCapabilities('gabbro', 3, 10, ['HEALTH'], 1);
testCapabilities('gabbro', 3, 10, ['RECT'], 0);
testCapabilities('gabbro', 3, 10, ['ROUND'], 1);
testCapabilities('gabbro', 3, 10, ['DISPLAY_144x168'], 0);
testCapabilities('gabbro', 3, 10, ['DISPLAY_180x180_ROUND'], 0);
testCapabilities('gabbro', 3, 10, ['DISPLAY_200x228'], 0);
testCapabilities('gabbro', 3, 10, ['DISPLAY_260x260_ROUND'], 1);
testCapabilities('gabbro', 3, 10, ['PLATFORM_APLITE'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_BASALT'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_CHALK'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_DIORITE'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_EMERY'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_FLINT'], 0);
testCapabilities('gabbro', 3, 10, ['PLATFORM_GABBRO'], 1);
testCapabilities('aplite', 3, 10, ['BW', 'HEALTH'], 0, 0);
testCapabilities('emery', 3, 10, ['COLOR', 'HEALTH'], 1);
@@ -224,6 +288,7 @@ describe('ClayConfig', function() {
'getItemByMessageKey',
'getItemById',
'getItemsByType',
'getItemsByGroup',
'serialize'
].forEach(function(method) {
it('.' + method + '()', function() {
@@ -287,6 +352,25 @@ describe('ClayConfig', function() {
});
});
describe('.getItemsByGroup()', function() {
it('it returns the correct items', function() {
var config = fixtures.config([
{type: 'input', id: 'g1-0', group: 'group1'},
{type: 'text', id: 'g2-0', group: 'group2'},
{type: 'input', id: 'g1-1', group: 'group1'}
]);
var clayConfig = fixtures.clayConfig(config);
assert.deepEqual(clayConfig.getItemsByGroup('group1'), [
clayConfig.getItemById('g1-0'),
clayConfig.getItemById('g1-1')
]);
assert.deepEqual(clayConfig.getItemsByGroup('group2'), [
clayConfig.getItemById('g2-0')
]);
});
});
describe('.serialize()', function() {
it('returns the correct settings', function() {
var config = [