mirror of
https://github.com/google/pebble.git
synced 2025-06-02 08:23:10 +00:00
Import the pebble dev site into devsite/
This commit is contained in:
Katharine Berry
parent
3b92768480
commit
527858cf4c
1359 changed files with 265431 additions and 0 deletions
70
devsite/source/docs/c/index.html
Normal file
70
devsite/source/docs/c/index.html
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
<!--
|
||||
Copyright 2025 Google LLC
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
---
|
||||
layout: docs
|
||||
permalink: /docs/c/
|
||||
title: C SDK Documentation
|
||||
docs_language: c
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-l-8">
|
||||
<div class="documentation documentation__c">
|
||||
<h1 class="pagetitle">{{ page.title }}</h1>
|
||||
<p>
|
||||
This is the contents page for the
|
||||
<a href="/sdk/download/">Pebble C SDK</a>. Here you will find
|
||||
information on all the available modules, functions and objects that can
|
||||
be used to create watchapps and watchfaces for Pebble.
|
||||
</p>
|
||||
<p>
|
||||
The C SDK is broken down into these {{ site.data.docs_tree.c.size }}
|
||||
top level modules. Click on them to browse around the rest of the SDK.
|
||||
</p>
|
||||
<p>
|
||||
You can also use the search bar at the top of the page to find what
|
||||
you are looking for.
|
||||
</p>
|
||||
|
||||
{% for module in site.data.docs_tree.c %}
|
||||
<div class="docs__module">
|
||||
<h4><a href="{{ module.url }}">{{ module.name }}</a></h4>
|
||||
{% if module.summary.size > 0 %}
|
||||
{{ module.summary }}
|
||||
{% else %}
|
||||
<p> </p>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-l-4">
|
||||
<div class="gray-box">
|
||||
<p>
|
||||
To learn more about how to use this SDK, take a look at the
|
||||
<a href="/guides/pebble-apps/">Writing Apps for Pebble</a> section of
|
||||
the Developer Guides.
|
||||
</p>
|
||||
<p>
|
||||
You can also view the
|
||||
<a href="/getting-started/watchface-tutorial/part1/">C SDK Tutorial</a>.
|
||||
This will guide you through the first stages to creating a Pebble
|
||||
watchface, adding customized images and fonts and extra
|
||||
web-based content.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
51
devsite/source/docs/c/preview/index.html
Normal file
51
devsite/source/docs/c/preview/index.html
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
<!--
|
||||
Copyright 2025 Google LLC
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
---
|
||||
layout: docs
|
||||
permalink: /docs/c/preview/
|
||||
title: C SDK Documentation (PREVIEW)
|
||||
docs_language: c_preview
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-l-8">
|
||||
<div class="documentation documentation__c">
|
||||
<h1 class="pagetitle">{{ page.title }}</h1>
|
||||
{% include docs/c/preview.html %}
|
||||
<p>
|
||||
This is the contents page for the preview version of the
|
||||
<a href="/sdk/download/">Pebble C SDK</a>. Here you will find
|
||||
information on all the available modules, functions and objects that can
|
||||
be used to create watchapps and watchfaces for Pebble.
|
||||
</p>
|
||||
<p>
|
||||
The C SDK is broken down into these {{ site.data.docs_tree.c_preview.size }}
|
||||
top level modules. Click on them to browse around the rest of the SDK.
|
||||
</p>
|
||||
|
||||
{% for module in site.data.docs_tree.c_preview %}
|
||||
<div class="docs__module">
|
||||
<h4><a href="{{ module.url }}">{{ module.name }}</a></h4>
|
||||
{% if module.summary.size > 0 %}
|
||||
{{ module.summary }}
|
||||
{% else %}
|
||||
<p> </p>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
80
devsite/source/docs/index.md
Normal file
80
devsite/source/docs/index.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
layout: docs/markdown
|
||||
title: SDK Documentation
|
||||
permalink: /docs/
|
||||
---
|
||||
|
||||
Welcome to the API Documentation section of the Pebble Developers site!
|
||||
|
||||
Here you will find complete listings of all the classes, objects, methods and
|
||||
functions available across all the parts of the Pebble API.
|
||||
|
||||
## Pebble Smartwatch APIs
|
||||
|
||||
Pebble's smartwatch APIs provide developers with a means of developing
|
||||
applications that run natively on Pebble smartwatches.
|
||||
|
||||
### [Pebble C API](/docs/c/)
|
||||
|
||||
The Pebble C API, used for creating native **watchapps and watchfaces** in C.
|
||||
The Pebble C API can be used in combination with *any* of the PebbleKit APIs
|
||||
listed below to extend the application's functionality.
|
||||
|
||||
### [Pebble JavaScript API](/docs/rockyjs/)
|
||||
|
||||
Pebble's embedded JavaScript API, used for creating native **watchfaces** in
|
||||
JavaScript. The embedded JavaScript API can be used in combination with
|
||||
PebbleKit JS to extend the application's functionality.
|
||||
|
||||
## PebbleKit APIs
|
||||
|
||||
The PebbleKit APIs provides developers with a means to extend their application's
|
||||
functionality by communicating with an application on the mobile device it is
|
||||
paired to.
|
||||
|
||||
### [PebbleKit JS](/docs/pebblekit-js/)
|
||||
|
||||
PebbleKit JS enables developers to extend their Pebble projects by adding a
|
||||
JavaScript component that is managed by the Pebble mobile app. PebbleKit JS is
|
||||
capable of bidirectional communication with with application running on the
|
||||
Pebble smartwatch
|
||||
|
||||
### [PebbleKit iOS](/docs/pebblekit-ios/)
|
||||
|
||||
PebbleKit iOS is an Objective-C library that enables developers to create
|
||||
companion apps for iOS devices that are capable for bi-directional communication
|
||||
with their Pebble API projects.
|
||||
|
||||
### [PebbleKit Android](/docs/pebblekit-android/)
|
||||
|
||||
PebbleKit Android is a Java library that enables developers to create companion
|
||||
apps for Android devices that are capable for bi-directional communication with
|
||||
their Pebble API projects.
|
||||
|
||||
{% comment %}
|
||||
## Web APIs
|
||||
|
||||
### [Timeline API](/docs/web-timeline/)
|
||||
|
||||
The Timeline API enables developers to create applications that interact with
|
||||
the user's Timeline, by creating and editing Timeline Pins.
|
||||
|
||||
### [AppGlance API](/docs/web-appglance)
|
||||
|
||||
The AppGlance web API enables developers to create applications that push
|
||||
information to the application's glance in the user's launcher.
|
||||
{% endcomment %}
|
||||
40
devsite/source/docs/pebblekit-android/index.md
Normal file
40
devsite/source/docs/pebblekit-android/index.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
permalink: /feed.xml
|
||||
layout: docs/markdown
|
||||
title: PebbleKit Android Documentation
|
||||
docs_language: pebblekit_android
|
||||
---
|
||||
|
||||
This is the contents page for the PebbleKit Android SDK documentation, which
|
||||
includes all information on the two main packages below:
|
||||
|
||||
{% for module in site.data.docs_tree.pebblekit_android %}
|
||||
<h3><a href="{{ module.url }}">{{ module.name }}</a></h3>
|
||||
<p/>
|
||||
{% endfor %}
|
||||
|
||||
This part of the SDK can be used to build companion apps for Android to enhance
|
||||
the features of the watchapp or to integrate Pebble into an existing mobile app
|
||||
experience.
|
||||
|
||||
Get started using PebbleKit Android by working through the
|
||||
[*Android Tutorial*](/tutorials/android-tutorial/part1). Check out
|
||||
{% guide_link communication/using-pebblekit-android %} to learn more about using
|
||||
this SDK.
|
||||
|
||||
You can also find the source code for PebbleKit Android
|
||||
[on GitHub](https://github.com/pebble/pebble-android-sdk).
|
||||
46
devsite/source/docs/pebblekit-ios/index.md
Normal file
46
devsite/source/docs/pebblekit-ios/index.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
permalink: /feed.xml
|
||||
layout: docs/markdown
|
||||
title: PebbleKit iOS Documentation
|
||||
docs_language: pebblekit_ios
|
||||
---
|
||||
|
||||
This is the contents page for the PebbleKit iOS SDK documentation, which
|
||||
includes all information on the main reference sections below.
|
||||
|
||||
This part of the SDK can be used to build companion apps for iOS to enhance the
|
||||
features of the watchapp or to integrate Pebble into an existing mobile app
|
||||
experience.
|
||||
|
||||
Get started using PebbleKit iOS by working through the
|
||||
[*iOS Tutorial*](/tutorials/ios-tutorial/part1). Check out
|
||||
{% guide_link communication/using-pebblekit-ios %} to learn more about using
|
||||
this SDK.
|
||||
|
||||
You can find the source code for PebbleKit iOS
|
||||
[on GitHub](https://github.com/pebble/pebble-ios-sdk), and the documentation
|
||||
is also available on
|
||||
[CocoaDocs](http://cocoadocs.org/docsets/PebbleKit/{{ site.data.sdk.pebblekit-ios.version }}/).
|
||||
|
||||
{% for module in site.data.docs_tree.pebblekit_ios %}
|
||||
<h3>{{ module.name }}</h3>
|
||||
{% for child in module.children %}
|
||||
<h5><a href="{{ child.url }}">{{ child.name }}</a></h5>
|
||||
{% endfor %}
|
||||
<p/>
|
||||
{% endfor %}
|
||||
|
||||
77
devsite/source/docs/pebblekit-js/index.html
Normal file
77
devsite/source/docs/pebblekit-js/index.html
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
permalink: /feed.xml
|
||||
layout: docs
|
||||
title: PebbleKit JavaScript Documentation
|
||||
docs_language: pebblekit_js
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-l-8">
|
||||
<div class="documentation documentation__js">
|
||||
<h1 class="pagetitle">{{ page.title }}</h1>
|
||||
|
||||
<p>
|
||||
PebbleKit JS is a JavaScript component of the Pebble SDK which runs
|
||||
within the Pebble mobile application. It provides access to GPS,
|
||||
storage and Internet connectivity to applications running on Pebble
|
||||
smartwatches.
|
||||
</p>
|
||||
|
||||
<div class="alert alert--large alert--fg-white alert--bg-dark-red">
|
||||
This does not relate to JavaScript running on the watch. For embedded
|
||||
JavaScript see <a href="/docs/rockyjs/">Rocky.js</a>.
|
||||
</div>
|
||||
|
||||
<p>
|
||||
The PebbleKit JS API is provided via the `Pebble` namespace:
|
||||
</p>
|
||||
<hr>
|
||||
|
||||
{% for module in site.data.docs_tree.pebblekit_js %}
|
||||
{% if module['kind'] == "member" or module['kind'] == "namespace" %}
|
||||
<div class="docs__module">
|
||||
<h4><a href="{{ module.url }}">{{ module.name }}</a></h4>
|
||||
<p>{{ module.summary | markdownify }}</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
<hr>
|
||||
|
||||
<p>PebbleKit JS also provides access to the following standard JS functionality:</p>
|
||||
<ul>
|
||||
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">WebSockets</a></li>
|
||||
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">XMLHttpRequest</a></li>
|
||||
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/Geolocation">Geolocation</a></li>
|
||||
<li><a href="https://developer.mozilla.org/en-US/docs/Web/API/LocalStorage">LocalStorage</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-l-4">
|
||||
<div class="gray-box">
|
||||
<p>
|
||||
To learn more about how to use this part of the Pebble SDK, check out the
|
||||
{% guide_link communication/using-pebblekit-js "PebbleKit JS guide" %},
|
||||
which also includes links to example apps.
|
||||
</p>
|
||||
<p>
|
||||
You can also view the third part of the
|
||||
<a href="/tutorials/watchface-tutorial/part3/">Create a C Watchface</a>
|
||||
tutorial series for an example JS implementation.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
74
devsite/source/docs/rockyjs/index.html
Normal file
74
devsite/source/docs/rockyjs/index.html
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
permalink: /feed.xml
|
||||
layout: docs
|
||||
title: Pebble Rocky.js API Documentation
|
||||
docs_language: rockyjs
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-l-8">
|
||||
<div class="documentation documentation__js">
|
||||
<h1 class="pagetitle">{{ page.title }}</h1>
|
||||
|
||||
<p>
|
||||
Pebble's JavaScript API allows developers to write watchfaces in
|
||||
JavaScript, that are executed via the firmware's
|
||||
<a href="//github.com/pebble/jerryscript">JerryScript</a> engine. For
|
||||
instructions on getting started with Pebble's JavaScript API, see the
|
||||
<a href="/tutorials/js-watchface-tutorial">JS Watchface Tutorial</a>.
|
||||
</p>
|
||||
|
||||
<p>The JavaScript API is broken down into the following modules:</p>
|
||||
|
||||
<hr>
|
||||
|
||||
{% for module in site.data.docs_tree.rockyjs %}
|
||||
|
||||
{% if module['kind'] == "member" or module['kind'] == "namespace" %}
|
||||
<div class="docs__module">
|
||||
<h4><a href="{{ module.url }}">{{ module.name }}</a></h4>
|
||||
<p>{{ module.summary | markdownify }}</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
<hr>
|
||||
<p>The JavaScript API also includes the following global functions:</p>
|
||||
|
||||
{% for module in site.data.docs_tree.rockyjs %}
|
||||
{% if module.kind == "function" %}
|
||||
<div class="docs__module">
|
||||
<div id="{{ module.name }}">
|
||||
{% include docs/js/function.html child=module global=true %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
<hr>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-l-4">
|
||||
<div class="gray-box">
|
||||
<p>
|
||||
To learn more about how to use this part of the Pebble SDK, check out the
|
||||
<a href="/tutorials/js-watchface-tutorial/">JavaScript Watchface tutorial</a>,
|
||||
which also includes links to example apps.
|
||||
</p>
|
||||
{% include docs/js/mozilla.html %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
34
devsite/source/docs/symbols.html
Normal file
34
devsite/source/docs/symbols.html
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
permalink: /feed.xml
|
||||
layout: docs
|
||||
permalink: /docs/symbols/
|
||||
---
|
||||
<div class="row">
|
||||
<div class="col-s-12">
|
||||
<table>
|
||||
{% for symbol in site.data.symbols %}
|
||||
<tr>
|
||||
<td>{{ symbol.language }}</td>
|
||||
<td><a href="{{ symbol.url }}">{{ symbol.name }}</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan=3>{{ symbol.summary }}</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
24
devsite/source/docs/symbols.json
Normal file
24
devsite/source/docs/symbols.json
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
---
|
||||
[
|
||||
{% for symbol in site.data.symbols %}
|
||||
{
|
||||
"name": "{{ symbol.name }}",
|
||||
"language": "{{ symbol.language }}",
|
||||
"url": "{{ symbol.url }}",
|
||||
"summary": "{{ symbol.summary | escape | newline_to_br | strip_newlines }}"
|
||||
}{% unless forloop.last %},{% endunless %}{% endfor %}
|
||||
]
|
||||
28
devsite/source/docs/tree.md
Normal file
28
devsite/source/docs/tree.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
layout: docs
|
||||
---
|
||||
|
||||
<div class="container content docs_tree">
|
||||
<ul>
|
||||
{% for language in site.data.docs_tree %}
|
||||
<li>{{ language | first }}
|
||||
{% assign tree = language[1] %}
|
||||
{% include docs/tree.html items=tree %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
Loading…
Add table
Add a link
Reference in a new issue