text
stringlengths 55
456k
| metadata
dict |
|---|---|
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. | {
"source": "openauthjs/openauth",
"title": "examples/quickstart/sst/README.md",
"url": "https://github.com/openauthjs/openauth/blob/master/examples/quickstart/sst/README.md",
"date": "2024-11-12T20:58:02",
"stars": 4721,
"description": "▦ Universal, standards-based auth provider.",
"file_size": 1449
} |
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. | {
"source": "openauthjs/openauth",
"title": "examples/quickstart/standalone/README.md",
"url": "https://github.com/openauthjs/openauth/blob/master/examples/quickstart/standalone/README.md",
"date": "2024-11-12T20:58:02",
"stars": 4721,
"description": "▦ Universal, standards-based auth provider.",
"file_size": 1449
} |
MIT License
Copyright (c) Fabian Hiller
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | {
"source": "openauthjs/openauth",
"title": "packages/openauth/node_modules/valibot/LICENSE.md",
"url": "https://github.com/openauthjs/openauth/blob/master/packages/openauth/node_modules/valibot/LICENSE.md",
"date": "2024-11-12T20:58:02",
"stars": 4721,
"description": "▦ Universal, standards-based auth provider.",
"file_size": 1064
} |
# Valibot
[![License: MIT][license-image]][license-url]
[![CI][ci-image]][ci-url]
[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]
[![JSR version][jsr-image]][jsr-url]
[![Discord][discord-image]][discord-url]
Hello, I am Valibot and I would like to help you validate data easily using a schema. No matter if it is incoming data on a server, a form or even configuration files. I have no dependencies and can run in any JavaScript environment.
> I highly recommend you read the [announcement post](https://www.builder.io/blog/introducing-valibot), and if you are a nerd like me, the [bachelor's thesis](https://valibot.dev/thesis.pdf) I am based on.
## Highlights
- Fully type safe with static type inference
- Small bundle size starting at less than 600 bytes
- Validate everything from strings to complex objects
- Open source and fully tested with 100 % coverage
- Many transformation and validation actions included
- Well structured source code without dependencies
- Minimal, readable and well thought out API
## Example
First you create a schema that describes a structured data set. A schema can be compared to a type definition in TypeScript. The big difference is that TypeScript types are "not executed" and are more or less a DX feature. A schema on the other hand, apart from the inferred type definition, can also be executed at runtime to guarantee type safety of unknown data.
<!-- prettier-ignore -->
```ts
import * as v from 'valibot'; // 1.24 kB
// Create login schema with email and password
const LoginSchema = v.object({
email: v.pipe(v.string(), v.email()),
password: v.pipe(v.string(), v.minLength(8)),
});
// Infer output TypeScript type of login schema
type LoginData = v.InferOutput<typeof LoginSchema>; // { email: string; password: string }
// Throws error for `email` and `password`
v.parse(LoginSchema, { email: '', password: '' });
// Returns data as { email: string; password: string }
v.parse(LoginSchema, { email: '[email protected]', password: '12345678' });
```
Apart from `parse` I also offer a non-exception-based API with `safeParse` and a type guard function with `is`. You can read more about it [here](https://valibot.dev/guides/parse-data/).
## Comparison
Instead of relying on a few large functions with many methods, my API design and source code is based on many small and independent functions, each with just a single task. This modular design has several advantages.
For example, this allows a bundler to use the import statements to remove code that is not needed. This way, only the code that is actually used gets into your production build. This can reduce the bundle size by up to 95 % compared to [Zod](https://zod.dev/).
In addition, it allows you to easily extend my functionality with external code and makes my source code more robust and secure because the functionality of the individual functions can be tested much more easily through unit tests.
## Credits
My friend [Fabian](https://twitter.com/FabianHiller) created me as part of his bachelor thesis at [Stuttgart Media University](https://www.hdm-stuttgart.de/en/), supervised by Walter Kriha, [Miško Hevery](https://twitter.com/mhevery) and [Ryan Carniato](https://twitter.com/RyanCarniato). My role models also include [Colin McDonnell](https://twitter.com/colinhacks), who had a big influence on my API design with [Zod](https://zod.dev/).
## Feedback
Find a bug or have an idea how to improve my code? Please fill out an [issue](https://github.com/fabian-hiller/valibot/issues/new). Together we can make the library even better!
## License
I am completely free and licensed under the [MIT license](https://github.com/fabian-hiller/valibot/blob/main/LICENSE.md). But if you like, you can feed me with a star on [GitHub](https://github.com/fabian-hiller/valibot).
[license-image]: https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square
[license-url]: https://opensource.org/licenses/MIT
[ci-image]: https://img.shields.io/github/actions/workflow/status/fabian-hiller/valibot/ci.yml?branch=main&logo=github&style=flat-square
[ci-url]: https://github.com/fabian-hiller/valibot/actions/workflows/ci.yml
[npm-image]: https://img.shields.io/npm/v/valibot.svg?style=flat-square
[npm-url]: https://npmjs.org/package/valibot
[downloads-image]: https://img.shields.io/npm/dm/valibot.svg?style=flat-square
[jsr-image]: https://jsr.io/badges/@valibot/valibot?style=flat-square
[jsr-url]: https://jsr.io/@valibot/valibot
[discord-image]: https://img.shields.io/discord/1252985447273992222?label=Discord&style=flat-square
[discord-url]: https://discord.gg/tkMjQACf2P | {
"source": "openauthjs/openauth",
"title": "packages/openauth/node_modules/valibot/README.md",
"url": "https://github.com/openauthjs/openauth/blob/master/packages/openauth/node_modules/valibot/README.md",
"date": "2024-11-12T20:58:02",
"stars": 4721,
"description": "▦ Universal, standards-based auth provider.",
"file_size": 4738
} |
# Transform your $20 Cursor into a Devin-like AI Assistant
This repository gives you everything needed to supercharge your Cursor/Windsurf IDE or GitHub Copilot with **advanced** agentic AI capabilities—similar to the $500/month Devin—but at a fraction of the cost. In under a minute, you'll gain:
* Automated planning and self-evolution, so your AI "thinks before it acts" and learns from mistakes
* Extended tool usage, including web browsing, search engine queries, and LLM-driven text/image analysis
* [Experimental] Multi-agent collaboration, with o1 doing the planning, and regular Claude/GPT-4o doing the execution.
## Why This Matters
Devin impressed many by acting like an intern who writes its own plan, updates that plan as it progresses, and even evolves based on your feedback. But you don't need Devin's $500/month subscription to get most of that functionality. By customizing the .cursorrules file, plus a few Python scripts, you'll unlock the same advanced features inside Cursor.
## Key Highlights
1. Easy Setup
Two ways to get started:
**Option 1: Using Cookiecutter (Recommended)**
```bash
# Install cookiecutter if you haven't
pip install cookiecutter
# Create a new project
cookiecutter gh:grapeot/devin.cursorrules --checkout template
```
**Option 2: Manual Setup**
Copy the `tools` folder and the following config files into your project root folder: Windsurf users need both `.windsurfrules` and `scratchpad.md` files. Cursor users only need the `.cursorrules` file. Github Copilot users need the `.github/copilot-instructions.md` file.
2. Planner-Executor Multi-Agent (Experimental)
Our new [multi-agent branch](https://github.com/grapeot/devin.cursorrules/tree/multi-agent) introduces a high-level Planner (powered by o1) that coordinates complex tasks, and an Executor (powered by Claude/GPT) that implements step-by-step actions. This two-agent approach drastically improves solution quality, cross-checking, and iteration speed.
3. Extended Toolset
Includes:
* Web scraping (Playwright)
* Search engine integration (DuckDuckGo)
* LLM-powered analysis
The AI automatically decides how and when to use them (just like Devin).
Note: For screenshot verification features, Playwright browsers will be installed automatically when you first use the feature.
4. Self-Evolution
Whenever you correct the AI, it can update its "lessons learned" in .cursorrules. Over time, it accumulates project-specific knowledge and gets smarter with each iteration. It makes AI a coachable and coach-worthy partner.
## Usage
For a detailed walkthrough of setting up and using devin.cursorrules with Cursor, check out our [step-by-step tutorial](step_by_step_tutorial.md). This guide covers everything from initial Cursor setup to configuring devin.cursorrules and using the enhanced capabilities.
1. Choose your setup method:
- **Cookiecutter (Recommended)**: Follow the prompts after running the cookiecutter command
- **Manual**: Copy the files you need from this repository
2. Configure your environment:
- Set up your API keys (optional)
3. Start exploring advanced tasks—such as data gathering, building quick prototypes, or cross-referencing external resources—in a fully agentic manner.
## Want the Details?
Check out our [blog post](https://yage.ai/cursor-to-devin-en.html) on how we turned $20 into $500-level AI capabilities in just one hour. It explains the philosophy behind process planning, self-evolution, and fully automated workflows. You'll also find side-by-side comparisons of Devin, Cursor, and Windsurf, plus a step-by-step tutorial on setting this all up from scratch.
License: MIT | {
"source": "grapeot/devin.cursorrules",
"title": "README.md",
"url": "https://github.com/grapeot/devin.cursorrules/blob/master/README.md",
"date": "2024-12-17T18:40:40",
"stars": 4639,
"description": "Magic to turn Cursor/Windsurf as 90% of Devin",
"file_size": 3708
} |
# Lessons
- For website image paths, always use the correct relative path (e.g., 'images/filename.png') and ensure the images directory exists
- For search results, ensure proper handling of different character encodings (UTF-8) for international queries
- Add debug information to stderr while keeping the main output clean in stdout for better pipeline integration
- When using seaborn styles in matplotlib, use 'seaborn-v0_8' instead of 'seaborn' as the style name due to recent seaborn version changes
- When using Jest, a test suite can fail even if all individual tests pass, typically due to issues in suite-level setup code or lifecycle hooks
## Windsurf learned
- For search results, ensure proper handling of different character encodings (UTF-8) for international queries
- Add debug information to stderr while keeping the main output clean in stdout for better pipeline integration
- When using seaborn styles in matplotlib, use 'seaborn-v0_8' instead of 'seaborn' as the style name due to recent seaborn version changes
- Use 'gpt-4o' as the model name for OpenAI's GPT-4 with vision capabilities
# Scratchpad | {
"source": "grapeot/devin.cursorrules",
"title": "scratchpad.md",
"url": "https://github.com/grapeot/devin.cursorrules/blob/master/scratchpad.md",
"date": "2024-12-17T18:40:40",
"stars": 4639,
"description": "Magic to turn Cursor/Windsurf as 90% of Devin",
"file_size": 1128
} |
# Step-by-Step Tutorial for Cursor with devin.cursorrules
This tutorial is designed for users who have never used Cursor before. We'll start from the beginning, covering installation, configuration, and how to use @grapeot's [`devin.cursorrules`](https://github.com/grapeot/devin.cursorrules) repository to transform Cursor into a self-evolving AI agent with tool-calling capabilities. While this document is designed for beginners, experienced Cursor users may also find it helpful. Feel free to skip sections you're already familiar with.
## Installation and Initial Configuration
Downloading and installing Cursor is similar to any other app. You can find the download link at the official website: [https://www.cursor.com/](https://www.cursor.com/). After launching Cursor for the first time, it will prompt you to log in. For first-time users, you'll need to click the register button to create an account on the official website.
To fully utilize Cursor, you'll need a Cursor Pro Plan subscription which costs $20 per month. However, Cursor provides a free trial period for new users. You can decide whether to subscribe after trying it out.
## Basic Interface
Cursor is a code editor where we typically open a folder to work in. For example, you can create a new folder like `~/Downloads/tmp` on your computer and use the "Open Folders" option in Cursor to open this location.
The interface consists of three main parts:
- Left sidebar: Shows the contents of your current folder (empty if you just created it)
- Middle area: Code editing space (though we'll primarily use Cursor's Agentic AI features)
- Right sidebar: Chat area where we communicate with Cursor, give instructions, and receive responses. If you don't see this area, press Command+I to show it.
Since we'll mainly use Cursor's Agentic AI features, I recommend making the composer sidebar wider.
Like VS Code, many of Cursor's features are accessed through commands in the command palette. You can press F1 to bring up the command palette. For example, if you can't remember how to bring up the composer panel, you can simply type "composer" in the command palette. It will show you options, and you can click the appropriate one to bring up the composer again. Commands also show keyboard shortcuts on the right, which you can memorize for faster access in the future.
## Important Initial Settings
For our use of Cursor's Agentic AI features, there are two crucial configurations to note:
1. At the top of the chat panel, there are three tabs: Chat, Composer, and Bug Finder. We'll primarily use the Composer tab. Be careful not to switch to the Chat tab, which uses the old interaction experience.
2. In the bottom right corner of the Composer panel, there's a toggle switch between "Normal" and "Agent". Make sure to switch it to "Agent" mode.
Additionally, in the bottom left corner of the chat panel, you can specify which AI model you want to use. Currently, Cursor's Agent mode supports three AI models: Claude, GPT-4o, and o3-mini. We generally recommend using Claude as it performs best in various scenarios, but feel free to experiment with other models.
Your configuration should look like this (note the Composer tab in the top left, Agent mode in the bottom right, and Claude in the bottom left):
## YOLO Mode Configuration
Before we start our first example, we need to make one more configuration change. In the top right corner of the Cursor interface, there's a gear icon. Clicking it will take you to Cursor's settings. On the left side of the settings screen, there are four tabs: General, Models, Features, and Beta. Click the third tab (Features) and scroll down to "Enable Yolo Mode".
Here, you can configure based on your preferences:
- If you want to review and manually confirm every command before AI executes it, leave this unchecked
- If you trust the AI not to harm your system and want it to execute commands automatically, you can check this option
Below this, the Yolo Prompt allows you to further customize when AI can automatically execute commands. For example, you might write something like: "Ask for confirmation when the command involves file deletion, e.g. rm, rmdir, rsync --delete, find -delete"
## First Example: Stock Price Visualization
Now that we have configured Cursor properly, let's try our first example to see Cursor's AI agent capabilities in action. In the Composer panel, we can type a simple request like "plot the stock price of Google and Amazon in 2024 and show them in one figure".
At this point, Cursor will use its Agent mode to analyze the task, understand the requirements, and decide to use Python to complete this task.
After Cursor automatically handles all the code writing, environment setup, and script execution, you'll see an image file generated in your current folder. When you click on this image file in the left sidebar, you'll see the stock price curves you requested.
This simple example demonstrates how Cursor's AI agent can understand natural language requests, write appropriate code, handle dependencies, and execute the code to produce the desired output, all without requiring you to write any code manually.
## Setting Up devin.cursorrules
Up to this point, we've been using Cursor's built-in features. While this AI agent is already powerful, it has several significant limitations: it can't self-evolve, can't remember learned experiences/lessons, and can't call some common external tools. To add these capabilities to Cursor, we can use @grapeot's repository: [https://github.com/grapeot/devin.cursorrules](https://github.com/grapeot/devin.cursorrules).
Here are the steps to configure and use this repo:
1. If you haven't installed Python yet, go to [https://www.python.org/downloads/](https://www.python.org/downloads/) or use your preferred package manager to install and configure Python.
2. Install the Cookiecutter dependency to easily initialize our Cursor project. In your system's command line (or Cursor's command window), run:
```bash
pip3 install cookiecutter
```
3. Go to where you want to place this Cursor project and execute this command:
```bash
cookiecutter gh:grapeot/devin.cursorrules --checkout template
```
If you get a "command not found: cookiecutter" error, try this command instead:
```bash
python3 -m cookiecutter gh:grapeot/devin.cursorrules --checkout template
```
It will launch a configuration wizard. Here is an example of the output:
```
➜ Downloads python3 -m cookiecutter gh:grapeot/devin.cursorrules --checkout template
/Users/grapeot/Library/Python/3.9/lib/python/site-packages/urllib3/__init__.py:35: NotOpenSSLWarning: urllib3 v2 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with 'LibreSSL 2.8.3'. See: https://github.com/urllib3/urllib3/issues/3020
warnings.warn(
You've downloaded /Users/grapeot/.cookiecutters/devin.cursorrules before. Is it okay to delete and re-download it? [y/n] (y):
[1/3] project_name (my-project): my-cursor-project
[2/3] Select project_type
1 - cursor
2 - windsurf
Choose from [1/2] (1):
[3/3] Select llm_provider [Optional. Press Enter to use None]
1 - None
2 - OpenAI
3 - Anthropic
4 - DeepSeek
5 - Google
6 - Azure OpenAI
Choose from [1/2/3/4/5/6] (1):
Creating virtual environment...
Installing dependencies...
```
The configuration has three steps:
1. Enter the name of your new project. Whatever name you enter, it will create a new subfolder with that name in the current directory and perform the configuration there.
2. Choose your project type. Currently, we support Cursor and Windsurf editors. Since we're using Cursor, just press Enter to select the default value (1).
3. Select an LLM Provider. This is an entirely optional configuration. When first starting, you can just press Enter to select None. It's only needed for some advanced features. We can start with None and come back to change it later when we're more familiar and need to use some advanced features.
The script will then automatically create the folder and configure the Python environment.
Next, you can use `cursor my-cursor-project` in the command line to open your newly created project, and you're ready to go.
## Using the Enhanced Tools
Using this enhanced Cursor project is similar to using a regular Cursor project, but now we have access to additional tools to better complete our tasks. For example, we can say "search recent news on OpenAI" in the prompt.
Remember to ensure you're in Composer and Agent mode before clicking "submit".
In this newly configured workspace, you'll notice Cursor has gained some additional capabilities. For instance, it will first edit our `.cursorrules` file for planning, then call our system search tools, and finally browse more web pages to get the latest information.
Now you are ready to use the enhanced Cursor project to complete your other tasks!
 | {
"source": "grapeot/devin.cursorrules",
"title": "step_by_step_tutorial.md",
"url": "https://github.com/grapeot/devin.cursorrules/blob/master/step_by_step_tutorial.md",
"date": "2024-12-17T18:40:40",
"stars": 4639,
"description": "Magic to turn Cursor/Windsurf as 90% of Devin",
"file_size": 9400
} |
# Instructions
During your interaction with the user, if you find anything reusable in this project (e.g. version of a library, model name), especially about a fix to a mistake you made or a correction you received, you should take note in the `Lessons` section in the `.github/copilot-instructions.md` file so you will not make the same mistake again.
You should also use the `.github/copilot-instructions.md` file's "scratchpad" section as a Scratchpad to organize your thoughts. Especially when you receive a new task, you should first review the content of the Scratchpad, clear old different task if necessary, first explain the task, and plan the steps you need to take to complete the task. You can use todo markers to indicate the progress, e.g.
[X] Task 1
[ ] Task 2
Also update the progress of the task in the Scratchpad when you finish a subtask.
Especially when you finished a milestone, it will help to improve your depth of task accomplishment to use the Scratchpad to reflect and plan.
The goal is to help you maintain a big picture as well as the progress of the task. Always refer to the Scratchpad when you plan the next step.
# Tools
Note all the tools are in python. So in the case you need to do batch processing, you can always consult the python files and write your own script.
## Screenshot Verification
The screenshot verification workflow allows you to capture screenshots of web pages and verify their appearance using LLMs. The following tools are available:
1. Screenshot Capture:
```bash
venv/bin/python tools/screenshot_utils.py URL [--output OUTPUT] [--width WIDTH] [--height HEIGHT]
```
2. LLM Verification with Images:
```bash
venv/bin/python tools/llm_api.py --prompt "Your verification question" --provider {openai|anthropic} --image path/to/screenshot.png
```
Example workflow:
```python
from screenshot_utils import take_screenshot_sync
from llm_api import query_llm
# Take a screenshot
screenshot_path = take_screenshot_sync('https://example.com', 'screenshot.png')
# Verify with LLM
response = query_llm(
"What is the background color and title of this webpage?",
provider="openai", # or "anthropic"
image_path=screenshot_path
)
print(response)
```
## LLM
You always have an LLM at your side to help you with the task. For simple tasks, you could invoke the LLM by running the following command:
```
venv/bin/python ./tools/llm_api.py --prompt "What is the capital of France?" --provider "anthropic"
```
The LLM API supports multiple providers:
- OpenAI (default, model: gpt-4o)
- Azure OpenAI (model: configured via AZURE_OPENAI_MODEL_DEPLOYMENT in .env file, defaults to gpt-4o-ms)
- DeepSeek (model: deepseek-chat)
- Anthropic (model: claude-3-sonnet-20240229)
- Gemini (model: gemini-pro)
- Local LLM (model: Qwen/Qwen2.5-32B-Instruct-AWQ)
But usually it's a better idea to check the content of the file and use the APIs in the `tools/llm_api.py` file to invoke the LLM if needed.
## Web browser
You could use the `tools/web_scraper.py` file to scrape the web.
```
venv/bin/python ./tools/web_scraper.py --max-concurrent 3 URL1 URL2 URL3
```
This will output the content of the web pages.
## Search engine
You could use the `tools/search_engine.py` file to search the web.
```
venv/bin/python ./tools/search_engine.py "your search keywords"
```
This will output the search results in the following format:
```
URL: https://example.com
Title: This is the title of the search result
Snippet: This is a snippet of the search result
```
If needed, you can further use the `web_scraper.py` file to scrape the web page content.
# Lessons
## User Specified Lessons
- You have a python venv in ./venv. Use it.
- Include info useful for debugging in the program output.
- Read the file before you try to edit it.
- Due to Cursor's limit, when you use `git` and `gh` and need to submit a multiline commit message, first write the message in a file, and then use `git commit -F <filename>` or similar command to commit. And then remove the file. Include "[Cursor] " in the commit message and PR title.
## Cursor learned
- For search results, ensure proper handling of different character encodings (UTF-8) for international queries
- Add debug information to stderr while keeping the main output clean in stdout for better pipeline integration
- When using seaborn styles in matplotlib, use 'seaborn-v0_8' instead of 'seaborn' as the style name due to recent seaborn version changes
- Use 'gpt-4o' as the model name for OpenAI's GPT-4 with vision capabilities
# Scratchpad | {
"source": "grapeot/devin.cursorrules",
"title": ".github/copilot-instructions.md",
"url": "https://github.com/grapeot/devin.cursorrules/blob/master/.github/copilot-instructions.md",
"date": "2024-12-17T18:40:40",
"stars": 4639,
"description": "Magic to turn Cursor/Windsurf as 90% of Devin",
"file_size": 4548
} |
<p align="center">
<img src="https://github.com/user-attachments/assets/57d23950-206b-4640-a649-66a175660ade" alt="Shortest logo" width="128" />
</p>
# Shortest
AI-powered natural language end-to-end testing framework.
<video src="https://github.com/user-attachments/assets/d443279e-7364-452b-9f50-0c8dd0cf55fc" controls autoplay loop muted>
Your browser does not support the video tag.
</video>
## Features
- Natural language E2E testing framework
- AI-powered test execution using Anthropic Claude API
- Built on Playwright
- GitHub integration with 2FA support
- Email validation with Mailosaur
## Using Shortest in your project
If helpful, [here's a short video](https://github.com/anti-work/shortest/issues/143#issuecomment-2564488173)!
### Installation
Use the `shortest init` command to streamline the setup process in a new or existing project.
The `shortest init` command will:
```sh
npx @antiwork/shortest init
```
This will:
- Automatically install the `@antiwork/shortest` package as a dev dependency if it is not already installed
- Create a default `shortest.config.ts` file with boilerplate configuration
- Generate a `.env.local` file (unless present) with placeholders for required environment variables, such as `ANTHROPIC_API_KEY`
- Add `.env.local` and `.shortest/` to `.gitignore`
### Quick start
1. Determine your test entry and add your Anthropic API key in config file: `shortest.config.ts`
```typescript
import type { ShortestConfig } from "@antiwork/shortest";
export default {
headless: false,
baseUrl: "http://localhost:3000",
testPattern: "**/*.test.ts",
ai: {
provider: "anthropic",
},
} satisfies ShortestConfig;
```
Anthropic API key will default to `SHORTEST_ANTHROPIC_API_KEY` / `ANTHROPIC_API_KEY` environment variables. Can be overwritten via `ai.config.apiKey`.
2. Create test files using the pattern specified in the config: `app/login.test.ts`
```typescript
import { shortest } from "@antiwork/shortest";
shortest("Login to the app using email and password", {
username: process.env.GITHUB_USERNAME,
password: process.env.GITHUB_PASSWORD,
});
```
### Using callback functions
You can also use callback functions to add additional assertions and other logic. AI will execute the callback function after the test
execution in browser is completed.
```typescript
import { shortest } from "@antiwork/shortest";
import { db } from "@/lib/db/drizzle";
import { users } from "@/lib/db/schema";
import { eq } from "drizzle-orm";
shortest("Login to the app using username and password", {
username: process.env.USERNAME,
password: process.env.PASSWORD,
}).after(async ({ page }) => {
// Get current user's clerk ID from the page
const clerkId = await page.evaluate(() => {
return window.localStorage.getItem("clerk-user");
});
if (!clerkId) {
throw new Error("User not found in database");
}
// Query the database
const [user] = await db
.select()
.from(users)
.where(eq(users.clerkId, clerkId))
.limit(1);
expect(user).toBeDefined();
});
```
### Lifecycle hooks
You can use lifecycle hooks to run code before and after the test.
```typescript
import { shortest } from "@antiwork/shortest";
shortest.beforeAll(async ({ page }) => {
await clerkSetup({
frontendApiUrl:
process.env.PLAYWRIGHT_TEST_BASE_URL ?? "http://localhost:3000",
});
});
shortest.beforeEach(async ({ page }) => {
await clerk.signIn({
page,
signInParams: {
strategy: "email_code",
identifier: "[email protected]",
},
});
});
shortest.afterEach(async ({ page }) => {
await page.close();
});
shortest.afterAll(async ({ page }) => {
await clerk.signOut({ page });
});
```
### Chaining tests
Shortest supports flexible test chaining patterns:
```typescript
// Sequential test chain
shortest([
"user can login with email and password",
"user can modify their account-level refund policy",
]);
// Reusable test flows
const loginAsLawyer = "login as lawyer with valid credentials";
const loginAsContractor = "login as contractor with valid credentials";
const allAppActions = ["send invoice to company", "view invoices"];
// Combine flows with spread operator
shortest([loginAsLawyer, ...allAppActions]);
shortest([loginAsContractor, ...allAppActions]);
```
### API testing
Test API endpoints using natural language
```typescript
const req = new APIRequest({
baseURL: API_BASE_URI,
});
shortest(
"Ensure the response contains only active users",
req.fetch({
url: "/users",
method: "GET",
params: new URLSearchParams({
active: true,
}),
}),
);
```
Or simply:
```typescript
shortest(`
Test the API GET endpoint ${API_BASE_URI}/users with query parameter { "active": true }
Expect the response to contain only active users
`);
```
### Running tests
```bash
pnpm shortest # Run all tests
pnpm shortest __tests__/login.test.ts # Run specific test
pnpm shortest --headless # Run in headless mode using CLI
```
You can find example tests in the [`examples`](./examples) directory.
### CI setup
You can run Shortest in your CI/CD pipeline by running tests in headless mode. Make sure to add your Anthropic API key to your CI/CD pipeline secrets.
[See example here](https://github.com/anti-work/shortest/blob/main/.github/workflows/shortest.yml)
### GitHub 2FA login setup
Shortest supports login using GitHub 2FA. For GitHub authentication tests:
1. Go to your repository settings
2. Navigate to "Password and Authentication"
3. Click on "Authenticator App"
4. Select "Use your authenticator app"
5. Click "Setup key" to obtain the OTP secret
6. Add the OTP secret to your `.env.local` file or use the Shortest CLI to add it
7. Enter the 2FA code displayed in your terminal into Github's Authenticator setup page to complete the process
```bash
shortest --github-code --secret=<OTP_SECRET>
```
### Environment setup
Required in `.env.local`:
```bash
ANTHROPIC_API_KEY=your_api_key
GITHUB_TOTP_SECRET=your_secret # Only for GitHub auth tests
```
## Shortest CLI development
The [NPM package](https://www.npmjs.com/package/@antiwork/shortest) is located in [`packages/shortest/`](./packages/shortest). See [CONTRIBUTING](./packages/shortest/CONTRIBUTING.md) guide.
## Web app development
This guide will help you set up the Shortest web app for local development.
### Prerequisites
- React >=19.0.0 (if using with Next.js 14+ or Server Actions)
- Next.js >=14.0.0 (if using Server Components/Actions)
> [!WARNING]
> Using this package with React 18 in Next.js 14+ projects may cause type conflicts with Server Actions and `useFormStatus`
>
> If you encounter type errors with form actions or React hooks, ensure you're using React 19
### Getting started
1. Clone the repository:
```bash
git clone https://github.com/anti-work/shortest.git
cd shortest
```
2. Install dependencies:
```bash
npm install -g pnpm
pnpm install
```
### Environment setup
#### For Anti-Work team members
Pull Vercel env vars:
```bash
pnpm i -g vercel
vercel link
vercel env pull
```
#### For other contributors
1. Run `pnpm run setup` to configure the environment variables.
2. The setup wizard will ask you for information. Refer to "Services Configuration" section below for more details.
### Set up the database
```bash
pnpm drizzle-kit generate
pnpm db:migrate
pnpm db:seed # creates stripe products, currently unused
```
### Services configuration
You'll need to set up the following services for local development. If you're not a Anti-Work Vercel team member, you'll need to either run the setup wizard `pnpm run setup` or manually configure each of these services and add the corresponding environment variables to your `.env.local` file:
<details>
<summary>Clerk</summary>
1. Go to [clerk.com](https://clerk.com) and create a new app.
2. Name it whatever you like and **disable all login methods except GitHub**.
3. Once created, copy the environment variables to your `.env.local` file.
4. In the Clerk dashboard, disable the "Require the same device and browser" setting to ensure tests with Mailosaur work properly.
</details>
<details>
<summary>Vercel Postgres</summary>
1. Go to your dashboard at [vercel.com](https://vercel.com).
2. Navigate to the Storage tab and click the `Create Database` button.
3. Choose `Postgres` from the `Browse Storage` menu.
4. Copy your environment variables from the `Quickstart` `.env.local` tab.
</details>
<details>
<summary>Anthropic</summary>
1. Go to your dashboard at [anthropic.com](https://anthropic.com) and grab your API Key.
- Note: If you've never done this before, you will need to answer some questions and likely load your account with a balance. Not much is needed to test the app.
</details>
<details>
<summary>Stripe</summary>
1. Go to your `Developers` dashboard at [stripe.com](https://stripe.com).
2. Turn on `Test mode`.
3. Go to the `API Keys` tab and copy your `Secret key`.
4. Go to the terminal of your project and type `pnpm run stripe:webhooks`. It will prompt you to login with a code then give you your `STRIPE_WEBHOOK_SECRET`.
</details>
<details>
<summary>GitHub OAuth</summary>
1. Create a GitHub OAuth App:
- Go to your GitHub account settings.
- Navigate to `Developer settings` > `OAuth Apps` > `New OAuth App`.
- Fill in the application details:
- **Application name**: Choose any name for your app
- **Homepage URL**: Set to `http://localhost:3000` for local development
- **Authorization callback URL**: Use the Clerk-provided callback URL (found in below image)
2. Configure Clerk with GitHub OAuth:
- Go to your Clerk dashboard.
- Navigate to `Configure` > `SSO Connections` > `GitHub`.
- Select `Use custom credentials`
- Enter your `Client ID` and `Client Secret` from the GitHub OAuth app you just created.
- Add `repo` to the `Scopes`
</details>
<details>
<summary>Mailosaur</summary>
1. [Sign up](https://mailosaur.com/app/signup) for an account with Mailosaur.
2. Create a new Inbox/Server.
3. Go to [API Keys](https://mailosaur.com/app/keys) and create a standard key.
4. Update the environment variables:
- `MAILOSAUR_API_KEY`: Your API key
- `MAILOSAUR_SERVER_ID`: Your server ID
The email used to test the login flow will have the format `shortest@<MAILOSAUR_SERVER_ID>.mailosaur.net`, where
`MAILOSAUR_SERVER_ID` is your server ID.
Make sure to add the email as a new user under the Clerk app.
</details>
### Running locally
Run the development server:
```bash
pnpm dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to see the app in action. | {
"source": "anti-work/shortest",
"title": "README.md",
"url": "https://github.com/anti-work/shortest/blob/main/README.md",
"date": "2024-09-18T20:44:05",
"stars": 4466,
"description": "QA via natural language AI tests",
"file_size": 11764
} |
The MIT License (MIT)
Copyright (c) 2024–2025 Gumroad, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | {
"source": "anti-work/shortest",
"title": "license.md",
"url": "https://github.com/anti-work/shortest/blob/main/license.md",
"date": "2024-09-18T20:44:05",
"stars": 4466,
"description": "QA via natural language AI tests",
"file_size": 1084
} |
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.4.1] - 2025-01-07
### Added
- Update readme with CLI example by @Harry Roper
- Update README with non-engineer introduction and example tests by @devin-ai-integration[bot]
- Add token usage details in summary by @khalatevarun
- Add baseURL configuration to BrowserManager context by @PedroAVJ
- Update test command example with directory path by @devin-ai-integration[bot]
- Move AI processing logic to more appropriate location by @PedroAVJ
### Fixed
- Improve AI handling of newly opened tabs by @rmarescu
## [0.4.0] - 2025-01-02
### Added
- Chained testing by @crabest
- 'before' function support by @slavingia
- Bash tool by @gladyshcodes
### Changed
- Adjusted the prompt to expect successful test execution by @crabest
- Updated Copyright year from 2024 to 2025 by @crabest
- Refactored config to detect test.ts files instead of files under test directory by @khalatevarun
- Improved index.d.ts generation by @amk-dev
- Updated shortest.config.ts by @slavingia
- Updated npm readme by @m2rads
### Removed
- Removed yarn support by @m2rads
**Full Changelog**: https://github.com/anti-work/shortest/compare/v0.3.0...v0.4.0
## [0.3.0] - 2024-12-30
### Changes
- Added Caching
## [0.2.1] - 2024-12-27
## Added
- Mailosaur integration with error handling for email validation
- Browser-based email preview functionality
- Test execution delay utility (sleep_milliseconds)
## [0.1.1] - 2024-12-24
### Fixed
- Fixed installation of playwright browser in setup script
- Add more robust error handling for playwright browser installation
## [0.1.0] - 2024-12-19
### Added
- Added mouse tracking and click animations for better user experience
## [0.0.9] - 2024-12-17
### Fixed
- Fixed page down and page up browser action
## [0.0.8] - 2024-12-16
### Added
- Added support for playwright's browser and playwright object model
- Rename test namespace to shortest
- Added new lifecycle method called .after() that will only run after the specific test case
- Improve system prompt to be more robust and structured
- Added Windows support for playwright install command
## [0.0.7] - 2024-12-12
### Fixed
- Fixed hooks context not being reset between tests
### Added
- Fixed Cli installation issues
- Updated README with more detailed instructions
## [0.0.5] - 2024-12-09
### Fixed
- Fixed FS build error
- Fixed CLI --headless flag to override config file
### Changed
- Improved Config file loading
⚠️ **Known Issues**
- Using this version with React 18 in Next.js 14+ projects may cause type conflicts with Server Actions and `useFormStatus`
- If you encounter type errors with form actions or React hooks, ensure you're using React 19
## [0.0.4] - 2024-12-06
### Added
- Improved browser navigation performance
- Enhanced AI prompt generation
- Added more robus test reporting
- Add support for playwright's page object model
### Changed
- Simplified test writing with a more intuitive API
- Moved screenshots to `.shortest/screenshots` directory with auto-cleanup
- Removed browser session persistence
## [0.0.3] - 2024-12-01
### Fixed
- Fixed execution order of lifecycle hooks
- Fixed CLI help command requiring GitHub TOTP secret
- Improved browser navigation performance using 'load' instead of 'networkidle'
- Fixed GitHub tool initialization to be lazy-loaded
- Improved error handling in browser navigation
### Changed
- Reduced navigation timeouts for better performance
- Made GitHub TOTP validation more flexible
- Improved browser cleanup on process termination
## [0.0.2] - 2024-11-28
### Fixed
- Fixed type declarations for global functions (define, expect)
- Fixed UITestBuilder type exports
- Improved TypeScript integration in consuming projects
## [0.0.1] - 2024-11-28
### Added
- Initial release (contained type declaration bugs)
- AI-powered test execution using Claude 3.5 Sonnet
- Natural language test writing support
- GitHub integration with 2FA support
- Automatic retry and error handling
- Browser automation using Playwright
- CLI tool for running tests
- Support for ESM and CommonJS
### PeeDependencies
- Playwright ^1.42.1
- Anthropic AI SDK 0.32.0
- esbuild ^0.20.1
- expect ^29.7.0
- dotenv ^16.4.5 | {
"source": "anti-work/shortest",
"title": "packages/shortest/CHANGELOG.md",
"url": "https://github.com/anti-work/shortest/blob/main/packages/shortest/CHANGELOG.md",
"date": "2024-09-18T20:44:05",
"stars": 4466,
"description": "QA via natural language AI tests",
"file_size": 4423
} |
# Contributing to Shortest
Thanks for your interest in contributing! This document will help you get started.
## Quick start
1. Set up the repository
```bash
git clone https://github.com/anti-work/shortest.git
cd shortest
pnpm install
```
2. Link CLI for local development
```bash
cd packages/shortest && pnpm link --global
cd ../.. && pnpm link --global shortest
```
3. Configure environment
```bash
cp .env.example .env.local
# Add your ANTHROPIC_API_KEY to .env.local
```
## Development
1. Create your feature branch
```bash
git checkout -b feature/your-feature
```
2. Run the test suite
```bash
pnpm test:unit
```
3. Build the CLI package
```bash
pnpm build
```
4. Test your changes
```bash
pnpm shortest --help
```
5. To test in another project:
```bash
pnpm pack
# In your test project
npm install /path/to/antiwork-shortest-{version}.tgz
npx shortest -h
```
## Pull requests
1. Update documentation if you're changing behavior
2. Add or update tests for your changes
3. Update CHANGELOG.md with your changes
4. Make sure all tests pass
5. Request a review from maintainers
6. After reviews begin, avoid force-pushing to your branch
- Force-pushing rewrites history and makes review threads hard to follow
- Don't worry about messy commits - we squash everything when merging to `main`
## Style guide
- Write in TypeScript
- Follow the existing code patterns
- Use clear, descriptive variable names
## Writing commit messages
We use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
A commit message should be structured as follows:
```bash
type(scope): title
description
```
Where type can be:
* `feat`: new feature or enhancement
* `fix`: bug fixes
* `docs`: documentation-only changes
* `test`: test-only changes
* `refactor`: code improvements without behaviour changes
* `chore`: maintenance/anything else
Example:
```
feat(cli): Add mobile testing support
```
## Help
- Check existing [discussions](https://github.com/anti-work/shortest/discussions)/[issues](https://github.com/anti-work/shortest/issues)/[PRs](https://github.com/anti-work/shortest/pulls) before creating new ones
- Start a discussion for questions or ideas
- [Open an issue](https://github.com/anti-work/shortest/issues/new/choose) for bugs or problems | {
"source": "anti-work/shortest",
"title": "packages/shortest/CONTRIBUTING.md",
"url": "https://github.com/anti-work/shortest/blob/main/packages/shortest/CONTRIBUTING.md",
"date": "2024-09-18T20:44:05",
"stars": 4466,
"description": "QA via natural language AI tests",
"file_size": 2303
} |
# Shortest
AI-powered natural language end-to-end testing framework.
## Features
- Natural language test writing
- AI-powered test execution using Claude computer use API
- Built on Playwright
- GitHub integration with 2FA support
### Installation
Use the `shortest init` command to streamline the setup process in a new or existing project.
The `shortest init` command will:
```sh
npx @antiwork/shortest init
```
This will:
- Automatically install the `@antiwork/shortest` package as a dev dependency if it is not already installed
- Create a default `shortest.config.ts` file with boilerplate configuration
- Generate a `.env.local` file (unless present) with placeholders for required environment variables, such as
`SHORTEST_ANTHROPIC_API_KEY` or `ANTHROPIC_API_KEY`
- Add `.env.local` and `.shortest/` to `.gitignore`
### Quick start
1. Determine your test entry and add your Anthropic API key in config file: `shortest.config.ts`
```typescript
import type { ShortestConfig } from "@antiwork/shortest";
export default {
headless: false,
baseUrl: "http://localhost:3000",
testPattern: "**/*.test.ts",
ai: {
provider: "anthropic",
},
} satisfies ShortestConfig;
```
Anthropic API key will default to `SHORTEST_ANTHROPIC_API_KEY` / `ANTHROPIC_API_KEY` environment variables. Can be overwritten via `ai.config.apiKey`.
2. Create test files using the pattern specified in the config: `app/login.test.ts`
```typescript
import { shortest } from "@antiwork/shortest";
shortest("Login to the app using email and password", {
username: process.env.GITHUB_USERNAME,
password: process.env.GITHUB_PASSWORD,
});
```
### Using callback functions
You can also use callback functions to add additional assertions and other logic. AI will execute the callback function after the test
execution in browser is completed.
```typescript
import { shortest } from "@antiwork/shortest";
import { db } from "@/lib/db/drizzle";
import { users } from "@/lib/db/schema";
import { eq } from "drizzle-orm";
shortest("Login to the app using username and password", {
username: process.env.USERNAME,
password: process.env.PASSWORD,
}).after(async ({ page }) => {
// Get current user's clerk ID from the page
const clerkId = await page.evaluate(() => {
return window.localStorage.getItem("clerk-user");
});
if (!clerkId) {
throw new Error("User not found in database");
}
// Query the database
const [user] = await db
.select()
.from(users)
.where(eq(users.clerkId, clerkId))
.limit(1);
expect(user).toBeDefined();
});
```
### Lifecycle hooks
You can use lifecycle hooks to run code before and after the test.
```typescript
import { shortest } from "@antiwork/shortest";
shortest.beforeAll(async ({ page }) => {
await clerkSetup({
frontendApiUrl:
process.env.PLAYWRIGHT_TEST_BASE_URL ?? "http://localhost:3000",
});
});
shortest.beforeEach(async ({ page }) => {
await clerk.signIn({
page,
signInParams: {
strategy: "email_code",
identifier: "[email protected]",
},
});
});
shortest.afterEach(async ({ page }) => {
await page.close();
});
shortest.afterAll(async ({ page }) => {
await clerk.signOut({ page });
});
```
### Chaining tests
Shortest supports flexible test chaining patterns:
```typescript
// Sequential test chain
shortest([
"user can login with email and password",
"user can modify their account-level refund policy",
]);
// Reusable test flows
const loginAsLawyer = "login as lawyer with valid credentials";
const loginAsContractor = "login as contractor with valid credentials";
const allAppActions = ["send invoice to company", "view invoices"];
// Combine flows with spread operator
shortest([loginAsLawyer, ...allAppActions]);
shortest([loginAsContractor, ...allAppActions]);
```
Shortest's style allows non-engineers such as designers, marketers, and PMs to write tests. Here are some examples:
```typescript
shortest("visit every page and ensure no typos");
shortest("visit every page and ensure mobile layout isn't janky");
shortest("visit every page and ensure dark mode is considered");
```
### API Testing
Test API endpoints using natural language
```typescript
const req = new APIRequest({
baseURL: API_BASE_URI,
});
shortest(
"Ensure the response contains only active users",
req.fetch({
url: "/users",
method: "GET",
params: new URLSearchParams({
active: true,
}),
}),
);
```
Or simply:
```typescript
shortest(`
Test the API GET endpoint ${API_BASE_URI}/users with query parameter { "active": true }
Expect the response to contain only active users
`);
```
### Running tests
```bash
pnpm shortest # Run all tests
pnpm shortest login.test.ts # Run specific test
pnpm shortest --headless # Run in headless mode using cli
```
You can find example tests in the [`examples`](./examples) directory.
### GitHub 2FA login setup
Shortest currently supports login using Github 2FA. For GitHub authentication tests:
1. Go to your repository settings
2. Navigate to "Password and Authentication"
3. Click on "Authenticator App"
4. Select "Use your authenticator app"
5. Click "Setup key" to obtain the OTP secret
6. Add the OTP secret to your `.env.local` file or use the Shortest CLI to add it
7. Enter the 2FA code displayed in your terminal into Github's Authenticator setup page to complete the process
```bash
shortest --github-code --secret=<OTP_SECRET>
```
### Environment setup
Required in `.env.local`:
```bash
ANTHROPIC_API_KEY=your_api_key
GITHUB_TOTP_SECRET=your_secret # Only for GitHub auth tests
```
### CI setup
You can run Shortest in your CI/CD pipeline by running tests in headless mode. Make sure to add your Anthropic API key to your CI/CD pipeline secrets.
## Resources
- Visit [GitHub](https://github.com/anti-work/shortest) for detailed docs
- [Contributing guide](./CONTRIBUTING.md)
- [Changelog](https://github.com/anti-work/shortest/releases)
### Prerequisites
- React >=19.0.0 (if using with Next.js 14+ or Server Actions)
- Next.js >=14.0.0 (if using Server Components/Actions)
> [!WARNING]
> Using this package with React 18 in Next.js 14+ projects may cause type conflicts with Server Actions and `useFormStatus`
> If you encounter type errors with form actions or React hooks, ensure you're using React 19 | {
"source": "anti-work/shortest",
"title": "packages/shortest/README.md",
"url": "https://github.com/anti-work/shortest/blob/main/packages/shortest/README.md",
"date": "2024-09-18T20:44:05",
"stars": 4466,
"description": "QA via natural language AI tests",
"file_size": 6373
} |
# PebbleOS
This is the latest version of the internal repository from Pebble Technology
providing the software to run on Pebble watches. Proprietary source code has
been removed from this repository and it will not compile as-is. This is for
information only.
This is not an officially supported Google product. This project is not
eligible for the [Google Open Source Software Vulnerability Rewards
Program](https://bughunters.google.com/open-source-security).
## Restoring the Directory Structure
To clarify the licensing of third party code, all non-Pebble code has been
moved into the `third_party/` directory. A python script is provided to
restore the expected structure. It may be helpful to run this script first:
```
./third_party/restore_tree.py
```
## Missing Components
Some parts of the firmware have been removed for licensing reasons,
including:
- All of the system fonts
- The Bluetooth stack, except for a stub that will function in an emulator
- The STM peripheral library
- The voice codec
- ARM CMSIS
- For the Pebble 2 HR, the heart rate monitor driver
Replacements will be needed for these components if you wish to use the
corresponding functionality. | {
"source": "google/pebble",
"title": "README.md",
"url": "https://github.com/google/pebble/blob/main/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1183
} |
# [developer.pebble.com][site]
[][travis]
This is the repository for the [Pebble Developer website][site].
The website is built using [Jekyll](http://jekyllrb.com) with some plugins that
provide custom functionality.
For anyone who wants to contribute to the content of the site, you should find
the information in one of the sections below.
* [Blog Posts](#blog-posts)
* [Markdown](#markdown)
* [Landing Page Features](#landing-page-features)
* [Colors](#colors)
## Getting Started
Once you have cloned the project you will need to run `bundle install` to
install the Ruby dependencies. If you do not have [bundler](http://bundler.io/)
installed you will need to run `[sudo] gem install bundler` first.
You should also do `cp .env.sample .env` and edit the newly created `.env` file
with the appropriate values. Take a look at the
[Environment Variables documentation](/docs/environment.md) for more details.
To start the Jekyll web server, run `bundle exec jekyll serve`.
## JS Documentation
The PebbleKit JS and Rocky documentation is generated with the
[documentation.js](documentation.js.org) framework. The documentation tool can
create a JSON file from the JSDocs contained in the [js-docs](/js-docs)
folder.
To install documentation.js, run `npm install -g documentation`
To regenerate the `/source/_data/rocky-js.json` file, run `./scripts/generate-rocky-docs.sh`
> **NOTE**: This is intended to be a temporary hack. Ideally the rocky-js.json
> file is generated as part of the release generator (and built using the actual
> Rocky.js source, or stubs in the Tintin repository.
## Blog Posts
### Setting up a new author
Add your name to the `source/_data/authors.yml` so the blog knows who you are!
```
blogUsername:
name: First Last
photo: https://example.com/you.png
```
### Creating a new blog post
Add a Markdown file in `source/_posts/` with a filename in following the
format: `YYYY-MM-DD-Title-of-the-blog-most.md`.
Start the file with a block of YAML metadata:
```
---
title: Parlez-vous Pebble? Sprechen sie Pebble? ¿Hablas Pebble?
author: blogUsername
tags:
- Freshly Baked
---
```
You should pick one tag from this list:
* Freshly Baked - Posts announcing or talking about new features
* Beautiful Code - Posts about writing better code
* "#makeawesomehappen" - Hackathons/events/etc
* At the Pub - Guest Blog Posts (presumably written at a pub)
* Down the Rabbit Hole - How Pebble works 'on the inside'
* CloudPebble - Posts about CloudPebble
* Timeline - Posts about Timeline
### Setting the post's preview text
The blog's homepage will automatically generate a 'preview' of your blog post. It does this by finding the first set of 3 consecutive blank lines, and using everything before those lines as the preview.
You should aim to have your preview be 1-2 paragraphs, and end with a hook that causes the reader to want to click the 'Read More' link.
## Markdown
There is a [Markdown styleguide and additional syntax cheatsheat][markdown]
you should use if you are writing any Markdown for the site. That includes all
blog posts and guides.
## Landing Page Features
The landing page of the website contains a slideshow (powered by [slick][slick]).
The contents of the slideshow, or 'features' as we call them, are generated
from the features data file found at `source/_data/features.yaml`.
There are two main types of features, images and videos.
### Image Feature
```yaml
- title: Want to make your apps more internationally friendly?
url: /guides/publishing-tools/i18n-guide/
background_image: /images/landing-page/i18n-guide.png
button_text: Read our brand new guide to find out how
button_fg: black
button_bg: yellow
duration: 5000
```
It should be relatively clear what each of the fields is for. For the
`button_fg` and `button_bg` options, check out the [colors](#colors) section
for the available choices.
The `background_image` can either be a local asset file or an image on an
external web server.
**Please Remember:** The landing page will see a lot of traffic so you
should strive to keep image sizes small, while still maintaing relatively large
dimensions. Run the images through minifying tools, such as
[TinyPNG][tinypng] or [TinyJPG][tinyjpg], before commiting them to the site.
### Video Feature
```yaml
- title: Send a Smile with Android Actionable Notifications
url: /blog/2014/12/19/Leverage-Android-Actionable-Notifications/
background_image: /images/landing-page/actionable-notifications.png
video:
url: https://s3.amazonaws.com/developer.getpebble.com/videos/actionable-notifications.mp4
button_text: Learn how to supercharge Your Android Apps
button_fg: white
button_bg: green
duration: 5000
```
To prevent massively bloating the size of this repository, we are hosting all
videos externally on S3. If you do not have permission to upload videos to our
S3 bucket, you will need to ask someone who does!
In order to enable to videos to play across all of the browsers + platforms,
you will need to provided the video in MP4, OGV and WEBM formats.
There is a script provided in the scripts folder to do the automatic conversion
from MP4, and to export the first frame of the video as a PNG used as a
placeholder while the video loads.
```sh
./scripts/video-encode.sh PATH_TO_MP4
```
If you run the script as above, it will create an OGV, WEBM and PNG file in the same folder as the MP4. The PNG file should go in the `/assets/images/landing-page/` folder, and the three video files should be uploaded to S3.
## Colors
Buttons and Alerts come are available in several different color options, with
both foreground and background modifier classes to give you maximum control.
The available colors:
* white
* green
* blue
* red
* purple
* yellow
* orange
* lightblue
* dark-red
To set the background, use `--bg-<COLOR>` modifier. To set the foreground (i.e)
the text color, use `--fg-<COLOR>`.
## Troubleshooting
Trouble building the developer site? Read the [Troubleshooting](/docs/troubleshooting.md) page for some possible solutions.
[site]: https://developer.pebble.com
[markdown]: ./docs/markdown.md
[slick]: http://kenwheeler.github.io/slick/
[tinypng]: https://tinypng.com/
[tinyjpg]: https://tinyjpg.com/
[travis]: https://magnum.travis-ci.com/pebble/developer.getpebble.com | {
"source": "google/pebble",
"title": "devsite/README.md",
"url": "https://github.com/google/pebble/blob/main/devsite/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 6417
} |
Doxygen pro tips
---
- Define top-level groups and other doxygen constructs in `docs/common.dox`.
- The main page can be found in `docs/mainpage_sdk.dox`
- Use \ref to create a cross reference in the documentation to another group, function, struct, or any kind of symbol, for example: `Use \ref app_event_loop() to do awesome shit.` will create a clickable link to the documentation of app_event_loop. Don't forget to add the () parens if the symbol is a function! Using angle brackets like <app_event_loop()> doesn't seem to work reliably, nor does the automatic detection of symbols.
- Use the directive `@internal` to indicate that a piece of documentation is internal and should not be included in the public SDK documentation. You can add the @internal halfway, so that the first part of your docstrings will be included in the public SDK documentation, and the part after the @internal directive will also get included in our internal docs.
- Use `@param param_name Description of param` to document a function parameter.
- Use `@return Description of return value` to document the return value of a function.
- If you need to add a file or directory that doxygen should index, add its path to `INPUT` in the Doxyfile-SDK configuration file.
- If you want to make a cross-reference to an external doc page (the conceptual pages on developer.getpebble.com), create an .html file in /docs/external_refs, containing only a <a> link to the page. Then use `\htmlinclude my_ref.html` to include that link in the docs. This extra level of indirection will make it easy to relocate external pages later on. | {
"source": "google/pebble",
"title": "docs/docstring-help.md",
"url": "https://github.com/google/pebble/blob/main/docs/docstring-help.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1606
} |
Each platform should be independent from one another.
For more information about the bootloader design:
https://pebbletechnology.atlassian.net/wiki/display/DEV/Bootloader+Contract | {
"source": "google/pebble",
"title": "platform/README.md",
"url": "https://github.com/google/pebble/blob/main/platform/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 180
} |
Pebble Firmware BETA5-136 Release Notes
==================================================
What's New
----------
* Added support for the charging LED on Pebble Steel
* Support for upgrading 1.x apps once we're already on 2.x
Bug Fixes
---------
* Mutex instrumentation for deadlock debugging
* New timer infrastructure
* Clock changes to fix display and power issues | {
"source": "google/pebble",
"title": "release-notes/beta5-136.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/beta5-136.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 370
} |
* Adds support for Pebble Steel charging indicator.
Bug Fixes
---------- | {
"source": "google/pebble",
"title": "release-notes/beta7-pre-rc.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/beta7-pre-rc.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 74
} |
Pebble Firmware v1.7.1a (Grand Slam) Release Notes
==================================================
Wed Jan 16 06:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.7a for the Pebble smart-watch. This early release includes a number of exciting features including enhancements to Pebble's power-management systems, improved notification support on Android & iOS, and a new, animated user interface.
What's New
----------
Enhanced Power Management: We've completed our first pass at reducing Pebble's power consumption. Users should expect to get approximately 2 days of battery life when paired with an iOS, and 4 days of battery life when paired with an Android device. Please let us know if your battery life doesn't match these estimates. To help track how long your watch has been running we've added an uptime readout to the 'About' screen.
Animated User Interface: v1.7 includes our initial pass at adding animation support to the user interface. This is still very much a work in progress, but we're very excited about what we have so far. If you encounter any poor performance regarding animations on your watch, be sure to let us know on the pebble-hacker mailing list.
Improved User Interface: We've incorporated feedback from our HackerBackers to improve several areas of Pebble's user interface. Please keep the excellent UI/UX feedback coming! Also, check out the new battery gauge in the status bar! (Hint: The battery gauge will not appear until it's time to charge your Pebble).
Android Notification Support: v1.7 now has support for incoming call notifications with call display on Android. Due to telephony limitations imposed by the Android OS, Pebble will only allow you to silence the ringer of an incoming call rather than rejecting it outright.
Android Music Control Support: Pebble now has support for music control on Android. In this release we're only providing support for several stock music players (namely the Samsung, HTC and Google Play apps), however we'll be incrementally adding support for additional players where possible. Did we miss your preferred music player? Be sure to let us know on the pebble-hacker mailing list. Due to limitations in the Spotify, Pandora and Songza apps, it is not possible for the Pebble Android application to control music playback from these services.
Fuzzy Time Watchface: Common Words has been replaced with "Fuzzy Time", a watchface that displays the time accurate to the nearest 5 minutes. This is the first of many watchfaces that will be available at launch.
Bug Fixes
Bug Fixes
---------
* The Pebble's Bluetooth address is now shown when in airplane mode.
* Lines in the notification app no longer end in an unprintable character (i.e. a box).
* Fixed issues affecting the accuracy of Pebble's internal clock.
* Fixed several UI glitches present in the 'Bluetooth' settings screen while in Airplane mode.
* Fixed a bug causing some notifications not to be displayed without content.
---
PebbleOS v1.7.0b (Grand Slam) Release Notes
===========================================
Thu Jan 17 04:00:00 UTC 2013
PebbleOS v1.7.0b is an update that fixes several critical bugs in PebbleOS v1.7.0a update.
Bug Fixes
---------
* Fixed a system stability problem causing sporadic reboots.
* Fixed an issue causing alarms to go off at the wrong time.
* Time is now correctly saved across device reboots.
* Fixed a bug that was causing stale data to be displayed in MAP notifications sent from iOS.
* Fixed a text-rendering bug that caused the Sliding Text watchface to occasionally freeze.
---
PebbleOS v1.7.1 (Grand Slam) Release Notes
==========================================
Tue Jan 22 23:00:00 UTC 2013
PebbleOS v1.7.1 is an update that fixes several critical bugs in the PebbleOS v1.7.1 update.
Bug Fixes
---------
* Fixed issues in Getting Started/Firmware Update processes.
* Fixed an issue with the notification UI showing the wrong icon.
* Fixed a few animation issues where the status bar behaved incorrectly.
* Fixed a few bugs in the HFP (iOS only) call notification UI.
* Changed the tap-to-backlight from the "up the screen" axis to the "into the screen" axis.
---
PebbleOS v1.7.2 (Grand Slam) Release Notes
==========================================
Thu Jan 24 03:00:00 UTC 2013
PebbleOS v1.7.2 is an update that fixes a bug in the PebbleOS v1.7.1 update.
Bug Fixes
---------
* Fixed an issue related to manufacturing line testability | {
"source": "google/pebble",
"title": "release-notes/grand-slam.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/grand-slam.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4470
} |
Pebble Firmware v1.8.1 (HM) Release Notes
==================================================
Wed Feb 6 22:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.8 for the Pebble SmartWatch. This early release includes...
What's New
----------
* Improved backlight control.
- Now configurable in the display settings menu.
- New option "AUTO" which controls the backlight using the ambient light sensor.
* Display settings are now persisted across resets
* Notification popups now time out after 3 minutes
* Persistent debug logs
- More information is now gathered on the watch to assist with support cases.
- This data will only be retrieved if the user manually submits a support case.
Bug Fixes
---------
* Fixed an issue with airplane mode causing the watchdog to resetting the watch if toggled too fast.
* Fixed a bug that caused certain MAP/SMS messages to crash the watch.
* Fixed the progress bar resetting between resource and firmware updates.
* Fixed some incorrect battery state transitions and thresholds.
* Fixed infrastructure surrounding updating PRF.
Pebble Firmware v1.8.1 (HM) Release Notes
==================================================
Mon Mar 4 20:30:00 UTC 2013
PebbleOS v1.8.2 is an update that fixes a bug in the PebbleOS v1.8.1 update.
Bug Fixes
---------
* Fixes erratic behavior of automatic backlight setting. | {
"source": "google/pebble",
"title": "release-notes/happy-meal.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/happy-meal.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1382
} |
Pebble Firmware v1.9.0 (INO) Release Notes
==================================================
Mon March 11 22:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.9 for the Pebble SmartWatch.
What's New
----------
* New watch-face interaction:
- Watch-faces have been removed from the main menu and are now accessible by
pressing the "BACK" button from the main menu
- Access the main menu from a watch-face by pressing "SELECT"
- Scroll through different watch faces by pressing "UP" and "DOWN" while
inside a watch-face
* New watch-face selector:
- View a list of installed watch-faces by through the new "Watchfaces" app
- Navigate to any installed watch-face and press "SELECT" to select a default
watch-face
* Facebook notification support for Android devices
* New text layout engine
Bug Fixes
----------
* Fixed a bug that caused inconsistent backlight behaviour when receiving a
notification in the dark
* Fixed an issue with the Bluetooth Settings menu that caused some device names
to appear empty
* Fixed a bug that caused cancelled outgoing calls to be labelled as "Missed Call"
* Fixed text alignment so that it is now applied past the first line of text
* Fixed a bug related to airplane mode causing resets in some circumstances
Pebble Firmware v1.9.1 (INO) Release Notes
==================================================
Tue Mar 26 19:00:00 UTC 2013
PebbleOS v1.9.1 is an update that fixes a critical bug present in versions 1.8.x and 1.9.
Bug Fixes
----------
* Fixed a bug that, on rare occasions, caused the Pebble to become unresponsive after being shut down. | {
"source": "google/pebble",
"title": "release-notes/in-n-out.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/in-n-out.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1644
} |
==================================================
Tuesday May 14 22:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.10.2 for the Pebble SmartWatch.
Bug Fixes
----------
* Fixed a bug in AppMessage error handling
* Fixed a crash in the alarm app
* Made minor layout tweaks to the built-in sports app | {
"source": "google/pebble",
"title": "release-notes/jr-whopper-v1.10.2.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/jr-whopper-v1.10.2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 336
} |
==================================================
Friday April 12 22:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.10 for the Pebble SmartWatch.
What's New
----------
* Added support for third-party watchfaces created by the watchface SDK
- See the SDK release notes for more details
* Resolved power-savings issues causing impaired battery life when connected to an iOS device
* Improved the responsiveness and power-efficiency of several system applications
* Improved battery indicator to be more responsive and accurate
* Added an option to disable turning on the backlight using the accelerometer
* Added an option to disable the vibe when a notification arrives
* Factory reset now removes all non-system applications and watchfaces
* "Allow Pebble to communicate..." pop-ups occur much less frequently on iOS
Bug Fixes
----------
* Fixed a crash that occurred when a email is sent over MAP on iOS with an empty subject
* Fixed a crash in the music app that occurred when Bluetooth was disabled
* Fixed a crash in the music app if tracks were changed too quickly when paired with an iOS device
* Fixed an issue where non-fullscreen apps that aren't animated don't render properly
* Fixed an edge-case where Pebble would not properly connect to an iOS device
* Fixed an issue where multiple vibration patterns would run concurrently | {
"source": "google/pebble",
"title": "release-notes/jr-whopper.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/jr-whopper.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1380
} |
==================================================
Wednesday May 29 22:00:00 UTC 2013
Pebble Technology is pleased to announce the release of PebbleOS v1.11 for the Pebble SmartWatch.
What's New
----------
* Improved Notification UI
- Allows multiple notifications to be viewed if they arrive within a short time frame
* Improved Set Time UI
* Added the option of showing your current speed (as oppossed to your pace) in the RunKeeper application.
* Swapped next and previous track buttons in the music application.
* Added the Simplicity watchface.
* Removed the Fuzzy Time watchface (it is available through the watchapp library).
Bug Fixes
----------
* Fixed a few issues where the bluetooth module would consume too much power.
* Fixed an issue where rounded rects drawn with graphics_fill_rect did not handle being clipped properly.
* Sped up text rendering when some of the text layer is clipped off the screen.
* Fixed a bug where the vibe would get stuck on.
* Fixed a crash when changing windows, most commonly seen in the set time and set alarm UIs.
* Fixed an issue where SMS messages on iOS would be incorrectly shown as an email with a very long subject line. | {
"source": "google/pebble",
"title": "release-notes/kiwiburger.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/kiwiburger.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1177
} |
Bug Fixes
----------
* Fixed a problem that caused the phone app to disconnect immediately after a firmware update. | {
"source": "google/pebble",
"title": "release-notes/litre-o-cola-v1.12.1.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/litre-o-cola-v1.12.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 117
} |
What's New
----------
* The backlight now turns on momentarily when a charger is connected
* Lots of goodies for watchapp developers that will be unlocked when the new PebbleKit is released
Bug Fixes
----------
* Fixed subject/sender cutoff in notifications with long subjects/senders
* Fixed motion backlight from sporadically not working
* Fixed factory reset to disable the QC app and perform the reset
* Fixed long click release after changing the action bar icon
* Fixed text_layer_get_max_used_size to always return the right size
* Fixed graphics draw pixel, circle, round rect to draw inside the layer
* Fixed graphics draw rect, round rect to use the stroke color
* Fixed graphics GCompOpAnd bitmap compositing mode to not have artifacts
* Fixed graphics gpath filled to not have cuts | {
"source": "google/pebble",
"title": "release-notes/litre-o-cola.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/litre-o-cola.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 798
} |
* Adds support for Apple Notification Center Service (ANCS) notifications for iOS 7 users with iPhone 4S, iPad 3, iPad mini or iPod Touch 5 or greater (requires Pebble iOS app 1.3 or greater). See help.getpebble.com for more information on setting up iOS7 notifications.
* The Pebble now can show >80 unread notifications, up from 8 previously.
Bug Fixes
----------
* Issues when receiving a phone call around not showing caller-ID, dismissing a call when pressing the back button, or continuing to vibrate, have been fixed.
* New iOS users no longer need to manage access to their address book in order to see Caller ID on their Pebble.
* Sometimes settings would be lost when the Pebble was rebooted. This issue is fixed. | {
"source": "google/pebble",
"title": "release-notes/mcrib.md",
"url": "https://github.com/google/pebble/blob/main/release-notes/mcrib.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 727
} |
# Pebble Developer Site · Development Guide
## Handlebars Templates
In order to reduce the size of the JS of the site, we are now pre-compiling
the Handlebars templates and just using the runtime Handlebars library.
If you change, add or remove from the templates, you just recompile them
into the file at `/source/assets/js/templates.js`.
There is a bash script at `/scripts/update-templates.sh` that you can use to
generate this file. | {
"source": "google/pebble",
"title": "devsite/docs/development.md",
"url": "https://github.com/google/pebble/blob/main/devsite/docs/development.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 447
} |
# Environment Variables
The following environment variables are used in the generation of the site.
## URL
This overrides the `url` configuration parameter of Jeyll. Set this to the root
of where the site will be hosted.
```
URL=http://developer.pebble.com
```
## HTTPS_URL
This overrides the `https_url` configuration parameter of Jeyll. Set this to
the secure root of where the site will be hosted.
```
HTTPS_URL=https://developer.pebble.com
```
## PORT
The port on which the Jekyll server will listen. If you don't set this it will
default to port `4000`.
```
PORT=8000
```
## ASSET_PATH
This sets the `asset_path` configuration variable, which tells the site where
the assets are to be found.
During development and testing, this can be set to the relative URL of the
assets folder inside the main site.
For production, this should be set to the CDN where the assets will be uploaded.
*Note:* As of 8th January 2014, the production version of the site still used
local assets and not a CDN.
```
ASSET_PATH=assets/
```
## EXTERNAL_SERVER
This sets the `external_server` configuration variable, which tells the site the
location of the external server used for events, community blog and contact.
```
EXTERNAL_SERVER=https://developer-api.getpebble.com
```
## DOCS_URL
The URL of the server on which the documentation sources are being built.
The production and staging values are private, so if you do not work for Pebble
you will have to omit it from the environment (or `.env` file). Sorry
## ALGOLIA_*
The site search is powered by [Algolia](https://algolia.com). There are four
environment variables that are required to turn on indexing at build time and
also correctly setup the client JS for searching. The production and staging
values can be found on our Algolia account.
If you do not work for Pebble, or don't care about testing the indexing, then
omit these values from the environment (or `.env` file) to disable Algolia.
The `ALGOLIA_PREFIX` value is extremely important. Make sure you set it if you
are enabling Algolia support on the site, and check that it matches the scoped
search key.
```
ALGOLIA_APP_ID=
ALGOLIA_API_KEY=
ALGOLIA_SEARCH_KEY=
ALGOLIA_PREFIX=
``` | {
"source": "google/pebble",
"title": "devsite/docs/environment.md",
"url": "https://github.com/google/pebble/blob/main/devsite/docs/environment.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2211
} |
# Writing Markdown
If you are writing anything in Markdown for the Pebble Developer site, you
should read this guide to learn about some of the rules and enhancements that
the site has, beyond those of "standard Markdown".
## Styleguide
### 80 character lines
To keep your Markdown files readable and easy to review, please break all lines
at 80 characters.
*NOTE:* The line breaking does not affect the HTML output, this is purely to
keep the source files readable and reviewable.
### Headers
Use the `#`, `##` etc syntax for headers, and include a space after the hashes
and before the header text.
```
## Write Headers Like This
##Don't Write Them Like This
And Definitely Don't Do This
=======
```
You should also generally avoid using the top level header (`#`) because the
page that is displaying the content will be using the document title in a \<h1\>
tag automatically.
#### Table of Contents
If enabled, the table of contents for the document will include all headers on
the page.
You can enable/disable table of contents generation for a specific page in the
YAML metadata:
```
generate_toc: true
```
#### Anchors
All headers automatically have anchors attached to them, so you can easily link
to sections of the page. The ID for the header will be the slugized header text.
For example, `## Install Your App` will become `#install-your-app`.
### Blockcode
Use triple backticks for block code, and
[specify the language](http://pygments.org/languages/) to ensure the syntax is
highlighted correctly.
```js
var foo = 'bar';
```
#### Click to Copy
By default, all code blocks will include the Click to Copy button in the
top right corner. If you want to disable it, prepend the language with `nc^`.
```nc^text
This is not for copying!
```
### Images
In blog posts and guides, images will be block elements that are centered on
the page. *Plan accordingly.*
#### Size
You can control the width (and optionally height) of images using the following
syntax:
```
```
### HTML
Do not use HTML unless you **absolutely** have to. It is almost always better to
use Markdown so that we can more easily maintain a consistent style across the
site.
## Additional Syntax
### Buttons
To convert any link into a button simply append a `>` onto the end of the text.
```
[Button Text >](http://google.com/)
```
You can optionally pass extra button classes after the `>` to modify the style
of the button.
```
[Wide Orange Button >{wide,fg-orange}](http://google.com)
```
The available classes are:
* wide
* small
* center
* fg-COLOR
* bg-COLOR
*Where COLOR is any one of the [available colors](README.md#colors).*
### Link Data
To add additional data attributes to links (useful for outbound tracking),
append a `>` to the end of the link title, and format the content as below.
```
[Link Text](http://google.com "Link Title >{track-event:click,track-name:google}")
```
This will create a link with the attributes `data-track-event="click"` and
`data-track-name="google"`.
### SDK Documentation Links
If you wish to link to a section of the SDK documentation, you can do so using
double backticks. This can either be done to enhance existing inline code
or in the text of a link.
```
This will link to the ``window_create`` documentation.
You should check out the page on [Events](``event services``)
```
### Pebble Screenshots
If you want to provide a watch screenshot and have it displayed in a Pebble
wrapper, you should upload the 144x168 image and use the following syntax.
```
```
You can pick from any of the following screenshot wrappers:
* pebble-screenshot--black
* pebble-screenshot--white
* pebble-screenshot--red
* pebble-screenshot--gray
* pebble-screenshot--orange
* pebble-screenshot--steel-black
* pebble-screenshot--steel-stainless
* pebble-screenshot--snowy-black
* pebble-screenshot--snowy-red
* pebble-screenshot--snowy-white
* pebble-screenshot--time-round-black-20
* pebble-screenshot--time-round-red-14
The following screenshot classes exist, but the accompanying images are not
currently available. They will be aliased to black-20 or red-14 as size
dictates:
* pebble-screenshot--time-round-rosegold-14
* pebble-screenshot--time-round-silver-14
* pebble-screenshot--time-round-silver-20
> Please match the wrapper to the screenshot where possible. For example, do not
use an original Pebble wrapper with a color screenshot.
#### Screenshot Viewer
If you want to show matching screenshots across multiple platforms, you should use the new
`screenshot_viewer` tag.
Here is an example of it in use:
```
{% screenshot_viewer %}
{
"image": "/images/guides/pebble-apps/display-animations/submenu.png",
"platforms": [
{ "hw": "basalt", "wrapper": "time-red" },
{ "hw": "chalk", "wrapper": "time-round-red-14" }
]
}
{% endscreenshot_viewer %}
```
The URL to the image gets the hardware platform insert into it, so in order to make
the above example work, you should have two files with the following names:
```
/source/assets/images/guides/pebble-apps/display-animations/submenu~basalt.png
/source/assets/images/guides/pebble-apps/display-animations/submenu~chalk.png
```
### Alerts
Some information requires more prominent formatting than standard block notes.
Use the `alert` Liquid tag for this purpose. Both 'notice' (purple) and
'important' (dark red) are supported for appropriate levels of highlighting.
Some examples are below:
```
{% alert important %}
PebbleKit JS and PebbleKit Android/iOS may **not** be used in conjunction.
{% endalert %}
```
```
{% alert notice %}
This API is currently in the beta stage, and may be changed before final
release.
{% endalert %}
```
### SDK Platform Specific Paragraphs
On pages that have the SDK Platform choice system, you can tag paragraphs as
being only relevant for CloudPebble or local SDK users. Text, code snippets,
images, and other markdown are all supported.
First, add `platform_choice: true` to the page YAML metadata.
Specify platform-specific sections of markdown using the `platform` Liquid tag:
```
{% platform local %}
Add the resource to your project in `package.json`.
{% endplatform %}
{% platform cloudpebble %}
Add the resource to your project by clicking 'Add New' next to 'Resources' in
the project sidebar.
{% endplatform %}
```
### Formatting
The following additional text formatting syntax is supported.
#### Strikethrough
```
This is some ~~terribly bad~~ amazingly good code.
```
#### Highlight
```
CloudPebble is ==extremely== good.
```
#### Tables
Tables are supported with the
[PHP Markdown syntax](https://michelf.ca/projects/php-markdown/extra/#table).
```
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
```
### Emoji
You can use emoji in your text by using the colon syntax.
```
If you're a beginner Pebble developer, you should use :cloud:Pebble
```
### Embedded Content
#### YouTube
To embed a YouTube video or playlist, use the standard link syntax with EMBED
as the link title.
```
You should check out this video on developing Pebble apps:
[EMBED](https://www.youtube.com/watch?v=LU_hPBhgjGQ)
```
#### Gist
To embed a GitHub Gist, use the standard link syntax with EMBED as the link
title.
```
Here is the Gist code.
[EMBED](https://gist.github.com/JaviSoto/5405969)
``` | {
"source": "google/pebble",
"title": "devsite/docs/markdown.md",
"url": "https://github.com/google/pebble/blob/main/devsite/docs/markdown.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 7578
} |
# Troubleshooting
This page contains fixes to known problems encountered from building the
developer site, and how they were fixed. This may help you if you have
the same problems.
## Nokogiri
**Error**
> An error occurred while installing nokogiri (1.6.7.2), and Bundler cannot continue.
> Make sure that `gem install nokogiri -v '1.6.7.2'` succeeds before bundling.
**Solution**
`gem install nokogiri -- --use-system-libraries` | {
"source": "google/pebble",
"title": "devsite/docs/troubleshooting.md",
"url": "https://github.com/google/pebble/blob/main/devsite/docs/troubleshooting.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 437
} |
---
# 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: more/markdown
title: App Inspiration
menu_subsection: inspiration
permalink: /inspiration/
generate_toc: true
page_class: inspiration-page
---
We're often asked by developers at hackathons and code days what kinds of apps
they should write for Pebble. It’s a great question and in an attempt to begin
answering it, we decided to publish a list of ideas and use cases that we would
love to see our developers tackling.
We hope that this list provides you with ideas, inspiration, and a
glimpse into what we hope to see more of in the future. If you have
any suggestions for ideas or categories we should add to this list,
please fill out
[this form](https://docs.google.com/forms/d/1S6_C4JP5HREK9jAolDXjOepEI1mkZpTTBm_GK6XIzg4/viewform)
and let us know what you think!
If you want to show us what you're working on, [reach out to us](/contact). We'd
love to provide feedback, connect developers to each other, showcase cool
apps in our developer newsletter, and even sponsor some amazing projects.
## Transportation
> When you’re on the move, the last thing you want to do is take out your phone.
We think about this in two categories: Navigation & Public Transit
### Navigation
Knowing when to take that left turn usually only requires a few well
timed glances. How can Pebble help you get from point A to point B in a way
that’s simple and efficient?
### Transit
Our Pebblers in the SF Bay Area rave about the
[Caltrain app](http://apps.getpebble.com/en_US/application/53eb5caf6743f7a863000201),
which gives us the closest Caltrain station, time until the next train,
and future train schedules. It has simplified our morning commute
dramatically and lets us keep our phones in our pockets at the right time.
How awesome would it be if Pebblers all over the world were able to have
that same luxury? Can we incorporate the Pebble timeline into that experience?
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28486/transportation-apps#latest)
## Workout Companions
> A personal trainer on your wrist
When you’re at the gym, it’s a pain to constantly pull out your phone
to figure out which exercise comes next, track your reps and time, and log
what you did. There are some great timers, stopwatches, running & biking
trackers, and rep counters out there, but we haven’t yet seen the whole
package come together.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28487/workout-companions#latest)
## Gift Cards, Loyalty, Ticketing
> Get rid of all those extra cards, apps, and keychains</p>
Aren’t you tired of carrying around a giant wallet or keeping track of
a bunch of paper tickets? As the device that’s always on you (and always on),
Pebble has the potential to replace all that clutter. How cool would it be
to walk into your favorite retailer, concert, sports game, pharmacy, or
gas station and have to do nothing but flash your magic wrist-wand? Pretty
cool.
Working with [Eventbrite](https://apps.getpebble.com/applications/55b7e74d180264f33f00007e)
made a lot of sense - get events on your Pebble timeline and launch your tickets
right from your wrist. How can we get everyone’s tickets and cards onto
their wrists?
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28498/gift-cards-loyalty-cards-and-ticketing#latest)
## Local Discovery
> What's happening in your city tonight?
Timeline is a great place to see your own events, but what about the
ones you have yet to discover? Imagine all the coolest events in your area
landing right on your timeline. We love using services like Eventbrite,
Meetup, Songkick, and Bandsintown to discover what’s going on near us —
how can we bring this to Pebble?
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28488/local-discovery#latest)
## Pebble to Pebble Communication
> Communicate with other Pebblers without taking out your phone
Simply put - Pebblers are awesome, and awesome people should stick
together. How cool would it be if you could communicate with other
Pebblers without even needing a phone?
[Boopy](https://apps.getpebble.com/applications/556211d49853b8c3f30000b9)
is an awesome start - how far can we take this?
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28489/watch-to-watch-communication#latest)
## Tasks, Reminders, Todo Lists
> Pebblers are busy people who get stuff done
With timeline as a core experience on the Pebble Time and the Voice API
coming soon, we’re excited to see how developers can make Pebble the
ultimate tool for productivity.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28490/tasks-reminders-to-dos#latest)
## Addictive Games
> Ever played [Pixel Miner](https://apps.getpebble.com/applications/539e18f21a19dec6ca0000aa)?
That’s one we can never put down….
Whether it’s about trivia, flapping birds, or paper planes, we’d love
to see more games in the appstore that endlessly entertain Pebblers and
keep them coming back for more.
And don’t forget, you’ve got a few tricks up your sleeve to keep them
coming back… (e.g. [timeline pins](/guides/pebble-timeline/), the
[Wakeup API](/guides/events-and-services/wakeups/)).
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28491/addictive-games#latest)
## Home
> Forget those remotes, switches, keys, and outlets — control and monitor your home with your watch
Studies show over 80% of Americans have at some point in their life
misplaced one of the above. With more of your home getting smarter and
more connected, Pebble can become the primary controller and monitor for everything.
[Leaf](https://apps.getpebble.com/applications/52ccd42551a80d792600002c)
is an awesome example -- let’s keep it going.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28492/pebble-for-the-home#latest)
## Security
> Pebble unlocks what matters
[Authenticator](https://apps.getpebble.com/applications/52f1a4c3c4117252f9000bb8)
has shown us the power of Pebble for easy two factor authentication. Whether
it’s for physical or digital spaces, a watch that’s always on you is the perfect
tool to keep what matters safe. Let’s see what else Pebble can unlock...
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28493/pebble-for-security#latest)
## Enterprise
> Businesses can't ignore wearables either...
Wearables provide a new, meaningful way for consumers to interface with
services, retailers, and brands. At the same time, employees and managers
have a newfound ability to notify, organize, coordinate, and learn from
one another. The grass is green and the sky’s the limit.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28494/pebble-for-businesses#latest)
## On Demand
> Making 'on-demand' even faster
People expect food, rides, dates, and just about anything else faster
and on-demand. Pebble is always with you, always on, and always a button
click away from something awesome.
Let’s give Pebble a few more superpowers…
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28495/pebble-for-on-demand#latest)
## Stay in the Know
> Pebblers want to stay on top of what's happening
The watch is a great place to consume little bits of information. News,
political events, music releases, entertainment, or anything else that
matters - we’d love to see how Pebble can help.
Let’s keep people in the know about what’s happening in the world,
wherever they are.
Maybe you even want to find ways to time-travel into
the future? We’re listening.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28496/pebble-and-staying-in-the-know#latest)
## Time
> Pebble at its core is a damn good watch
Time is the essence of everything we do here at Pebble. We’ve seen all
sorts of awesome watchfaces -- dynamic, digital, analog, weather... but
there’s always more that can be done. If you can think up and create new,
innovative ways to tell time, we’re interested.
[Join the Discussion >{more}](https://forums.getpebble.com/discussion/28497/time#latest)
---
Anything pique your interest? We certainly hope so! Fire up your
emulators, get building, and let’s **#makeawesomehappen** together.
Don't forget, we have some pretty cool
[design and interaction guides](/guides/design-and-interaction/)
to help you out.
Off you go! | {
"source": "google/pebble",
"title": "devsite/source/inspiration.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/inspiration.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 9034
} |
PULSE Flash Imaging
===================
This document describes the PULSE flash imaging protocol. This protocol
was originally designed for use over PULSEv1, but also works over the
PULSEv2 Best-Effort transport.
The flash imaging protocol is used to write raw data directly to the
external flash. It is a message-oriented protocol encapsulated in PULSE
frames. The primary goals of the protocol are reliability and speed over
high-latency links.
* All client-sent commands elicit responses
* As much as possible, any command can be resent without corrupting the
flashing process. This is to accommodate the situation where the
command was received and acted upon but the response was lost, and the
client retried the command.
* Any notification (server→client message which is not a response to a
command) can be lost without holding up the flashing process. There
must be a way to poll for the status of all operations which elicit
notifications.
* Most of the state is tracked by the client. The server only has to
maintain a minimal, fixed-size amount of state.
> The idempotence of writing to flash is leveraged in the design of this
> protocol to effectively implement a [Selective Repeat ARQ](http://en.wikipedia.org/wiki/Selective_Repeat_ARQ)
> with an unlimited window size without requiring the server to keep
> track of which frames are missing. Any Write Data command to the same
> location in flash can be repeated any number of times with no ill
> effects.
## Message format
All fields in a message which are more than one octet in length are
transmitted least-significant octet (LSB) first.
All messages begin with a 1-octet Opcode, followed by zero or more data
fields depending on the message. All Address fields are offsets from the
beginning of flash. Address and Length fields are specified in units of
bytes.
### Client Commands
#### 1 - Erase flash region
Address: 4 octets
Length: 4 octets
#### 2 - Write data to flash
Address: 4 octets
Data: 1+ octets
The data length is implied.
#### 3 - Checksum flash region
Address: 4 octets
Length: 4 octets
#### 4 - Query flash region geometry
Region: 1 octet
Region | Description
-------|-------------------
1 | PRF
2 | Firmware resources
#### 5 - Finalize flash region
Region: 1 octet
Inform the server that writing is complete and perform whatever task is
necessary to finalize the data written to the region. This may be a
no-op.
Region numbers are the same as for the "Query flash region geometry"
message.
### Server Responses
#### 128 - ACKnowledge erase command
Address: 4 octets
Length: 4 octets
Complete?: 1 octet
Complete field is zero if the erase is in progress, nonzero when the
erase is complete.
#### 129 - ACKnowledge write command
Address: 4 octets
Length: 4 octets
Complete?: 1 octet
#### 130 - Checksum result
Address: 4 octets
Length: 4 octets
Checksum: 4 octets
The legacy Pebble checksum ("STM32 CRC") of the specified memory is
returned.
#### 131 - Flash region geometry
Region: 1 octet
Address: 4 octets
Length: 4 octets
A length of zero indicates that the region does not exist.
#### 132 - ACKnowledge finalize flash region command
Region: 1 octet
#### 192 - Malformed command
Bad message: 9 octets
Error string: 0+ octets
#### 193 - Internal error
Error string: 0+ octets
Something has gone terribly wrong which prevents flashing from
proceeding.
<!-- vim: set tw=72: --> | {
"source": "google/pebble",
"title": "docs/pulse2/flash-imaging.md",
"url": "https://github.com/google/pebble/blob/main/docs/pulse2/flash-imaging.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 3431
} |
History of PULSEv2
==================
This document describes the history of the Pebble dbgserial console
leading up to the design of PULSEv2.
In The Beginning
----------------
In the early days of Pebble, the dbgserial port was used to print out
log messages in order to assist in debugging the firmware. These logs
were plain text and could be viewed with a terminal emulator such as
minicom. An interactive prompt was added so that firmware developers and
the manufacturing line could interact with the running firmware. The
prompt mode could be accessed by pressing CTRL-C at the terminal, and
could be exited by pressing CTRL-D. Switching the console to prompt mode
suppressed the printing of log messages. Data could be written into the
external flash memory over the console port by running a prompt command
to switch the console to a special "flash imaging" mode and sending it
base64-encoded data.
This setup worked well enough, though it was slow and a little
cumbersome to use at times. Some hacks were tacked on as time went on,
like a "hybrid" prompt mode which allowed commands to be executed
without suppressing log messages. These hacks didn't work terribly well.
But it didn't really matter as the prompt was only used internally and
it was good enough to let people get stuff done.
First Signs of Trouble
----------------------
The problems with the serial console started becoming apparent when
we started building out automated integration testing. The test
automation infrastructure made extensive use of the serial console to
issue commands to simulate actions such as button clicks, inspect the
firmware state, install applications, and capture screenshots and log
messages. From the very beginning the serial console proved to be very
unreliable for test automation's uses, dropping commands, corrupting
screenshots and other data, and hiding log messages. The test automation
harness which interacted with the dbgserial port became full of hacks
and workarounds, but was still very unreliable. While we wanted to have
functional and reliable automated testing, we didn't have the manpower
at the time to improve the serial console for test automation's use
cases. And so test automation remained frustratingly unreliable for a
long time.
PULSEv1
-------
During the development of Pebble Time, the factory was complaining that
imaging the recovery firmware onto external flash over the dbgserial
port was taking too long and was causing a manufacturing bottleneck. The
old flash imaging mode had many issues and was in need of a replacement
anyway, and improving the throughput to reduce manufacturing costs
finally motivated us to allocate engineering time to replace it.
The biggest reason the flash imaging protocol was so slow was that it
was extremely latency sensitive. After every 768 data bytes sent, the
sender was required to wait for the receiver to acknowledge the data
before continuing. USB-to-serial adapter ICs are used at both the
factory and by developers to interface the watches' dbgserial ports to
modern computers, and these adapters can add up to 16 ms latency to
communications in each direction. The vast majority of the flash imaging
time was wasted with the dbgserial port idle, waiting for the sender to
receive and respond to an acknowledgement.
There were other problems too, such as a lack of checksums. If line
noise (which wasn't uncommon at the factory) corrupted a byte into
another valid base64 character, the corruption would go unnoticed and be
written out to flash. It would only be after the writing was complete
that the integrity was verified, and the entire transfer would have to
be restarted from the beginning.
Instead of designing a new flash imaging protocol directly on top of the
raw dbgserial console, as the old flash imaging protocol did, a
link-layer protocol was designed which the new flash imaging protocol
would operate on top of. This new protocol, PULSE version 1, provided
best-effort multiprotocol datagram delivery with integrity assurance to
any applications built on top of it. That is, PULSE allowed
applications to send and receive packets over dbgserial, without
interfering with other applications simultaneously using the link, with
the guarantee that the packets either will arrive at the receiver intact
or not be delivered at all. It was designed around the use-case of flash
imaging, with the hope that other protocols could be implemented over
PULSE later on. The hope was that this was the first step to making test
automation reliable.
Flash imaging turns out to be rather unique, with affordances that make
it easy to implement a performant protocol without protocol features
that many other applications would require. Writing to flash memory is
an idempotent operation: writing the same bytes to the same flash
address _n_ times has the same effect as writing it just once. And
writes to different addresses can be performed in any order. Because
of these features of flash, each write operation can be treated as a
wholly independent operation, and the data written to flash will be
complete as long as every write is performed at least once. The
communications channel for flash writes does not need to be reliable,
only error-free. The protocol is simple: send a write command packet
with the target address and data. The receiver performs the write and
sends an acknowledgement with the address. If the sender doesn't receive
an acknowledgement within some timeout, it re-sends the write command.
Any number of write commands and acknowledgements can be in-flight
simulatneously. If a write completes but the acknowledgement is lost in
transit, the sender can re-send the same write command and the receiver
can naively overwrite the data without issue due to the idempotence of
flash writes.
The new PULSE flash imaging protocol was a great success, reducing
imaging time from over sixty seconds down to ten, with the bottleneck
being the speed at which the flash memory could be erased or written.
After the success of PULSE flash imaging, attempts were made to
implement other protocols on top of it, with varying degrees of success.
A protocol for streaming log messages over PULSE was implemented, as
well as a protocol for reading data from external flash. There were
attempts to implement prompt commands and even an RPC system using
dynamically-loaded binary modules over PULSE, but they required reliable
and in-order delivery, and implementing a reliable transmission scheme
separately for each application protocol proved to be very
time-consuming and bug-prone.
Other flaws in PULSE became apparent as it came into wider use. The
checksum used to protect the integrity of PULSE frames was discovered to
have a serious flaw, where up to three trailing 0x00 bytes could be
appended to or dropped from a packet without changing the checksum
value. This flaw, combined with the lack of explicit length fields in
the protocol headers, made it much more likely for PULSE flash imaging
to write corrupted data. This was discovered shortly after test
automation switched over to PULSE flash imaging.
Make TA Green Again
-------------------
Around January 2016, it was decided that the issues with PULSE that were
preventing test automation from fully dropping use of the legacy serial
console would best be resolved by taking the lessons learned from PULSE
and designing a successor. This new protocol suite, appropriately
enough, is called PULSEv2. It is designed with test automation in mind,
with the intention of completely replacing the legacy serial console for
test automation, developers and the factory. It is much better at
communicating and synchronizing link state, which solves problems that
test automation was running into with the firmware crashing and
rebooting getting the test harness confused. It uses a standard checksum
without the flaws of its predecessor, and packet lengths are explicit.
And it is future-proofed by having an option-negotiation mechanism,
allowing us to add new features to the protocol while allowing old and
new implementations to interoperate.
Applications can choose to communicate with either best-effort datagram
service (like PULSEv1), or reliable datagram service that guarantees
in-order datagram delivery. Having the reliable transport available
made it very easy to implement prompt commands over PULSEv2. And it was
also suprisingly easy to implement a PULSEv2 transport for the Pebble
Protocol, which allows developers and test automation to interact with
bigboards using libpebble2 and pebble-tool, exactly like they can with
emulators and sealed watches connected to phones.
Test automation switched over to PULSEv2 on 2016 May 31. It immediately
cut down test run times and, once some bugs got shaken out, measurably
improved the reliability of test automation. It also made the captured
logs from test runs much more useful as messages were no longer getting
dropped. PULSEv2 was made the default for all firmware developers at the
end of September 2016.
<!-- vim: set tw=72: --> | {
"source": "google/pebble",
"title": "docs/pulse2/history.md",
"url": "https://github.com/google/pebble/blob/main/docs/pulse2/history.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 9070
} |
PULSEv2 Protocol Suite
======================
Motivation
----------
The initial design of PULSE was shaped by its initial use case of flash
imaging. Flash imaging has a few properties which allowed it to be
implemented on top of a very simplistic wire protocol. Writing to flash
can be split up into any number of atomic write operations that can be
applied in arbitrary order. Flash writes are idempotent: repeatedly
writing the same data to the same flash address does not corrupt the
written data. Because of these properties, it was possible to implement
the flash imaging protocol in a stateless manner simply by ensuring that
every write was applied at least once without concern for out of order
delivery or duplicated datagrams. The PULSE link layer was designed as
simply as possible, guaranteeing only datagram integrity with only
best-effort reliability and sequencing, since it was all that the flash
imaging protocol needed.
As we try to use PULSE for more applications, it has become clear that
flash imaging is a special case. Most applications have some manner of
statefulness or non-idempotent operations, so they need guarantees about
reliable delivery and sequencing of datagrams in order to operate
correctly in the face of lost or corrupted datagrams. The lack of such
guarantees in PULSE has forced these applications to bake sequencing and
retransmissions into the application protocols in an ad-hoc manner,
poorly. This has made the design and implementation of prompt and file
transfer protocols more complex than necessary, and no attempt has yet
been made to tunnel Pebble Protocol over PULSE. It's the [waterbed
theory](http://wiki.c2.com/?WaterbedTheory) at work.
Adding support for reliable, ordered delivery of datagrams will allow
for any application to make use of reliable service simply by requesting
it. Implementation of chatty protocols will be greatly simplified.
Protocol Stack
--------------
PULSEv2 is a layered protocol stack. The link layer provides
integrity-assured delivery of packet data. On top of the link layer is a
suite of transport protocols which provide multiprotocol delivery of
application datagrams with or without guaranteed reliable in-order
delivery. Application protocols use one or more of the available
transports to exchange datagrams between the firmware running on a board
and a host workstation.
Physical Layer
--------------
PULSEv2 supports asynchronous serial byte-oriented full duplex links,
8-N-1, octets transmitted LSB first. The link must transparently pass
all octet values. The baud rate is 1,000,000 bps.
> **Why that baud rate?**
>
> 1 Mbaud is a convenient choice as it is the highest frequency which
> divides perfectly into a 16 MHz core clock at 16x oversampling, and
> works with zero error at 64, 80 and 100 MHz (with only 100 MHz
> requiring any fractional division at all). The only downside is that
> it is not a "standard" baud rate, but this is unlikely to be a problem
> as FTDI, PL2303, CP2102 (but not CP2101) and likely others will handle
> 1 Mbaud rates (at least in hardware). YMMV with Windows drivers...
Link Layer
----------
The link layer, in a nutshell, is PPP with custom framing. The entirety
of [RFC 1661](https://tools.ietf.org/html/rfc1661) is normative, except
as noted in this document.
### Encapsulation
PPP encapsulation (RFC 1661, Section 2) is used. The Padding field of
the PPP encapsulation must be empty.
A summary of the frame structure is shown below. This figure does not
include octets inserted for transparency. The fields are transmitted
from left to right.
Flag | Protocol | Information | FCS | Flag
-----|----------|-------------|----------|-----
0x55 | 2 octets | * | 4 octets | 0x55
#### Flag field
Each frame begins and ends with a Flag sequence, which is the octet 0x55
hexadecimal. The flag is used for frame synchronization.
> **Why 0x55?**
>
> It is transmitted as bit pattern `(1)0101010101`, which is really easy
> to spot on an oscilloscope trace or logic analyzer capture, and it
> allows for auto baud rate detection. The STM32F7 USART supports auto
> baud rate detection with an 0x55 character in hardware.
Only one Flag sequence is required between two frames. Two consecutive
Flag sequences constitute and empty frame, which is silently discarded.
#### Protocol field
The Protocol field is used as prescribed by RFC 1661, Section 2. PPP
assigned protocol numbers and their respective assigned protocols should
be used wherever it makes sense. Custom protocols must not be assigned
protocol numbers which overlap any [existing PPP assigned protocol](http://www.iana.org/assignments/ppp-numbers/ppp-numbers.xhtml).
#### Frame Check Sequence field
The Frame Check Sequence is transmitted least significant octet first.
The check sequence is calculated using the [CRC-32](http://reveng.sourceforge.net/crc-catalogue/all.htm#crc.cat.crc-32)
checksum. The parameters of the CRC algorithm are:
width=32 poly=0x04c11db7 init=0xffffffff refin=true refout=true
xorout=0xffffffff check=0xcbf43926 name="CRC-32"
The FCS field is calculated over all bits of the Protocol and
Information fields, not including any start and stop bits, or octets
inserted for transparency. This also does not include the Flag sequence
nor the FCS field itself.
### Transparency
Transparency is achieved by applying [COBS](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing)
encoding to the Protocol, Information and FCS fields, then replacing any
instances of 0x55 in the COBS-encoded data with 0x00.
### Link Operation
The Link Control Protocol packet format, assigned numbers and state
machine are the same as PPP (RFC 1661), with minor exceptions.
> Do not be put off by the length of the RFC document. Only a small
> subset of the protocol needs to be implemented (especially if there
> are no negotiable options) for an implementation to be conforming.
> All multi-byte fields in LCP packets are transmitted in Network
> (big-endian) byte order. The burden of converting from big-endian to
> little-endian is very minimal, and it lets Wireshark dissectors work
> on PULSEv2 LCP packets just like any other PPP LCP packet.
By prior agreement, peers MAY transmit or receive packets of certain
protocols while the link is in any phase. This is contrary to the PPP
standard, which requires that all non-LCP packets be rejected before the
link reaches the Authentication phase.
Transport Layer
---------------
### Best-Effort Application Transport (BEAT) protocol
Best-effort delivery with very little overhead, similar to PULSEv1.
#### Packet format
Application Protocol | Length | Information
---------------------|----------|------------
2 octets | 2 octets | *
All multibyte fields are in big-endian byte order.
The Length field encodes the number of octets in the Application
Protocol, Length and Information fields of the packet. The minimum value
of the Length field in a valid packet is 4.
BEAT application protocol 0x0001 is assigned to the PULSE Control
Message Protocol (PCMP). When a BEAT packet is received by a conforming
implementation with the Application Protocol field set to an
unrecognized value, a PCMP Unknown Protocol message MUST be sent.
#### BEAT Control Protocol (BECP)
BECP uses the same packet exchange mechanism as the Link Control
Protocol. BECP packets may not be exchanged until LCP is in the Opened
state. BECP packets received before this state is reached should be
silently discarded.
BECP is exactly the same as the Link Control Protocol with the following
exceptions:
* Exactly one BECP packet is encapsulated in the Information field of
Link Layer frames where the Protocol field indicates type 0xBA29 hex.
* Only codes 1 through 7 (Configure-Request, Configure-Ack,
Configure-Nak, Configure-Reject, Terminate-Request, Terminate-Ack and
Code-Reject) are used. Other codes should be treated as unrecognized
and should result in Code-Rejects.
* A distinct set of configure options are used. There are currently no
options defined.
#### Sending BEAT packets
Before any BEAT protocol packets may be communicated, both LCP and BECP
must reach the Opened state. Exactly one BEAT protocol packet is
encapsulated in the Information field of Link Layer frames where the
Protocol field indicates type 0x3A29 hex.
### PUSH (Simplex) transport
Simplex best-effort delivery of datagrams. It is designed for log
messages and other status updates from the firmware to the host. There
is no NCP, no options, no negotiation.
#### Packet format
Application Protocol | Length | Information
---------------------|----------|------------
2 octets | 2 octets | *
All multibyte fields are in big-endian byte order.
The Length field encodes the number of octets in the Application
Protocol, Length and Information fields of the packet. The minimum value
of the Length field in a valid packet is 4.
#### Sending PUSH packets
Packets can be sent at any time regardless of the state of the link,
including link closed. Exactly one PUSH packet is encapsulated in the
Information field of Link Layer frames where the Protocol field
indicates type 0x5021 hex.
### Reliable transport (TRAIN)
The Reliable transport provides reliable in-order delivery service of
multiprotocol application datagrams. The protocol is heavily based on
the [ITU-T Recommendation X.25](https://www.itu.int/rec/T-REC-X.25-199610-I/en)
LAPB data-link layer. The remainder of this section relies heavily on
the terminology used in Recommendation X.25. Readers are also assumed to
have some familiarity with section 2 of the Recommendation.
#### Packet formats
The packet format is, in a nutshell, LAPB in extended mode carrying BEAT
packets.
**Information command packets**
Control | Application Protocol | Length | Information
---------|----------------------|----------|------------
2 octets | 2 octets | 2 octets | *
**Supervisory commands and responses**
Control |
---------|
2 octets |
##### Control field
The control field is basically the same as LAPB in extended mode. Only
Information transfer and Supervisory formats are supported. The
Unnumbered format is not used as such signalling is performed
out-of-band using the TRCP control protocol. The Information command and
the Receive Ready, Receive Not Ready, and Reject commands and responses
are permitted in the control field.
The format and meaning of the subfields in the Control field are
described in ITU-T Recommendation X.25.
##### Application Protocol field
The protocol number for the message contained in the Information field.
This field is only present in Information packets. The Application
Protocol field is transmitted most-significant octet first.
##### Length field
The Length field specifies the number of octets covering the Control,
Application Protocol, Length and Information fields. The Length field is
only present in Information packets. The content of a valid Information
packet must be no less than six. The Length field is transmitted
most-significant octet first.
##### Information field
The application datagram itself. This field is only present in
Information packets.
#### TRAIN Control Protocol
The TRAIN Control Protocol, or TRCP for short, is used to set up and
tear down the communications channel between the two peers. TRCP uses
the same packet exchange mechanism as the Link Control Protocol. TRCP
packets may not be exchanged until LCP is in the Opened state. TRCP
packets received before this state is reached should be silently
discarded.
TRCP is exactly the same as the Link Control Protocol with the following
exceptions:
* Exactly one TRCP packet is encapsulated in the Information field of
Link Layer frames where the Protocol field indicates type 0xBA33 hex.
* Only codes 1 through 7 (Configure-Request, Configure-Ack,
Configure-Nak, Configure-Reject, Terminate-Request, Terminate-Ack and
Code-Reject) are used. Other codes should be treated as unrecognized
and should result in Code-Rejects.
* A distinct set of configure options are used. There are currently no
options defined.
The `V(S)` and `V(R)` state variables shall be reset to zero when the
TRCP automaton signals the This-Layer-Up event. All packets in the TRAIN
send queue are discarded when the TRCP automaton signals the
This-Layer-Finished event.
#### LAPB system parameters
The LAPB system parameters used in information transfer have the default
values described below. Some parameter values may be altered through the
TRCP option negotiation mechanism. (NB: there are currently no options
defined, so there is currently no way to alter the default values during
the protocol negotiation phase)
**Maximum number of bits in an I packet _N1_** is equal to eight times
the MRU of the link, minus the overhead imposed by the Link Layer
framing and the TRAIN header. This parameter is not negotiable.
**Maximum number of outstanding I packets _k_** defaults to 1 for both
peers. This parameter is (to be) negotiable. If left at the default, the
protocol will operate with a Stop-and-Wait ARQ.
#### Transfer of application datagrams
Exactly one TRAIN packet is encapsulated in the Information field of
Link Layer frames. A command packet is encapsulated in a Link Layer
frame where the Protocol field indicates 0x3A33 hex, and a response
packet is encapsulated in a Link Layer frame where the Protocol field
indicates 0x3A35 hex. Transfer of datagrams shall follow the procedures
described in Recommendation X.25 §2.4.5 _LAPB procedures for information
transfer_. A cut-down set of procedures for a compliant implementation
which only supports _k=1_ operation can be found in
[reliable-transport.md](reliable-transport.md).
In the event of a frame rejection condition (as defined in
Recommendation X.25), the TRCP automaton must be issued a Down event
followed by an Up event to cause an orderly renegotiation of the
transport protocol and reset the state variables. This is the same as
the Restart option described in RFC 1661. A FRMR response MUST NOT be
sent.
TRAIN application protocol 0x0001 is assigned to the PULSE Control
Message Protocol (PCMP). When a TRAIN packet is received by a conforming
implementation with the Application Protocol field set to an
unrecognized value, a PCMP Unknown Protocol message MUST be sent.
### PULSE Control Message Protocol
The PULSE Control Message Protocol (PCMP) is used for signalling of
control messages by the transport protocols. PCMP messages must be
encapsulated in a transport protocol, and are interpreted within the
context of the encapsulated transport protocol.
> **Why a separate protocol?**
>
> Many of the transports need to communicate the same types of control
> messages. Rather than defining a different way of communicating these
> messages for each protocol, they can use PCMP and share a single
> definition (and implementation!) of these messages.
#### Packet format
Code | Information
--------|------------
1 octet | *
#### Defined codes
##### 1 - Echo Request
When the transport is in the Opened state, the recipient MUST respond
with an Echo-Reply packet. When the transport is not Opened, any
received Echo-Request packets MUST be silently discarded.
##### 2 - Echo Reply
A reply to an Echo-Request packet. The Information field MUST be copied
from the received Echo-Request.
##### 3 - Discard Request
The receiver MUST silently discard any Discard-Request packet that it
receives.
##### 129 - Port Closed
A packet has been received with a port number unrecognized by the
recipient. The Information field must be filled with the port number
copied from the received packet (without endianness conversion).
##### 130 - Unknown PCMP Code
A PCMP packet has been received with a Code field which is unknown to
the recipient. The Information field must be filled with the Code field
copied from the received packet.
----
Useful Links
------------
* [The design document for PULSEv2](https://docs.google.com/a/pulse-dev.net/document/d/1ZlSRz5-BSQDsmutLhUjiIiDfVXTcI53QmrqENJXuCu4/edit?usp=sharing),
which includes a draft of this documentation along with a lot of
notes about the design decisions.
* [Python implementation of PULSEv2](https://github.com/pebble/pulse2)
* [Wireshark plugin for dissecting PULSEv2 packet captures](https://github.com/pebble/pulse2-wireshark-plugin)
* [RFC 1661 - The Point to Point Protocol (PPP)](https://tools.ietf.org/html/rfc1661)
* [RFC 1662 - PPP in HDLC-like Framing](https://tools.ietf.org/html/rfc1662)
* [RFC 1663 - PPP Reliable Transmission](https://tools.ietf.org/html/rfc1663)
* [RFC 1570 - PPP LCP Extensions](https://tools.ietf.org/html/rfc1570)
* [RFC 2153 - PPP Vendor Extensions](https://tools.ietf.org/html/rfc2153)
* [RFC 3772 - Point-to-Point Protocol (PPP) Vendor Protocol](https://tools.ietf.org/html/rfc3772)
* [PPP Consistent Overhead Byte Stuffing (COBS)](https://tools.ietf.org/html/draft-ietf-pppext-cobs)
* [ITU-T Recommendation X.25](https://www.itu.int/rec/T-REC-X.25-199610-I/en)
* [Digital Data Communications Message Protocol](http://www.ibiblio.org/pub/historic-linux/early-ports/Mips/doc/DEC/ddcmp-4.1.txt)
<!-- vim: set tw=72: --> | {
"source": "google/pebble",
"title": "docs/pulse2/pulse2.md",
"url": "https://github.com/google/pebble/blob/main/docs/pulse2/pulse2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 17260
} |
PULSEv2 Reliable Transport
==========================
The purpose of this document is to describe the procedures for the PULSEv2
reliable transport (TRAIN) to be used in the initial implementations, with
support for only Stop-and-Wait ARQ (Automatic Repeat reQuest). Hopefully,
limiting the scope in this way will make it simpler to implement compared to a
more performant Go-Back-N ARQ. This document is a supplement to the description
of TRAIN in [pulse2.md](pulse2.md).
The PULSEv2 reliable transport (TRAIN) is based on X.25 LAPB, which implements
reliable datagram delivery using a Go-Back-N ARQ (Automatic Repeat reQuest)
procedure. Since a Stop-and-Wait ARQ is equivalent to Go-Back-N with a window
size of 1, LAPB can be readily adapted for Stop-and-Wait ARQ. The description in
this document should hopefully be compatible with an implementation supporting
the full Go-Back-N LAPB procedures when that implementation is configured with a
window size of 1, so that there is a smooth upgrade path which doesn't require
special cases or compatibility breakages.
Documentation conventions
-------------------------
This document relies heavily on the terminology used in [ITU-T Recommendation
X.25](https://www.itu.int/rec/T-REC-X.25-199610-I/en). Readers are also assumed
to have some familiarity with section 2 of that document.
The term "station" is used in this document to mean "DCE or DTE".
Procedures for information transfer
-----------------------------------
There is no support for communicating a busy condition. It is assumed that a
station in a busy condition will silently drop packets, and that the timer
recovery procedure will be sufficient to ensure reliable delivery of the dropped
packets once the busy condition is cleared. An implementation need not support
sending or receiving RNR packets.
Sending I packets
-----------------
All Information transfer packets must be sent with the Poll bit set to 1. The
procedures from X.25 §2.4.5.1 apply otherwise.
Receiving an I packet
---------------------
When the DCE receives a valid I packet whose send sequence number N(S) is equal
to the DCE receive state variable V(R), the DCE will accept the information
fields of this packet, increment by one its receive state variable V(R), and
transmit an RR response packet with N(R) equal to the value of the DCE receive
state variable V(R). If the received I packet has the Poll bit set to 1, the
transmitted RR packet must be a response packet with Final bit set to 1.
Otherwise the transmitted RR packet should have the Final bit set to 0.
Reception of out-of-sequence I packets
--------------------------------------
Since the DTE should not have more than one packet in-flight at once, an
out-of-sequence I packet would be due to a retransmit: RR response for the most
recently received I packet got lost, so the DTE re-sent the I packet. Discard
the information fields of the packet and send an RR packet with N(R)=V(R).
Receiving acknowledgement
-------------------------
When correctly receiving a RR packet, the DCE will consider this packet as an
acknowledgement of the most recently-sent I packet if N(S) of the most
recently-sent I packet is equal to the received N(R)-1. The DCE will stop timer
T1 when it correctly receives an acknowledgement of the most recently-sent I
packet.
Since all I packets are sent with P=1, the receiving station is obligated to
respond with a supervisory packet. Therefore it is unnecessary to support
acknowledgements embedded in I packets.
Receiving an REJ packet
-----------------------
Since only one I packet may be in-flight at once, the REJ packet is due to the
RR acknowledgement from the DTE getting lost and the DCE retransmitting the I
packet. Treat it like an RR.
Waiting acknowledgement
-----------------------
The DCE maintains an internal transmission attempt variable which is set to 0
when the transport NCP signals a This-Layer-Up event, and when the DCE correctly
receives an acknowledgement of a sent I packet.
If Timer T1 runs out waiting for the acknowledgement from the DTE for an I
packet transmitted, the DCE will add one to its transmission attempt variable,
restart Timer T1 and retransmit the unacknowledged I packet.
If the transmission attempt variable is equal to N2 (a system parameter), the
DCE will initiate a restart of the transport link. | {
"source": "google/pebble",
"title": "docs/pulse2/reliable-transport.md",
"url": "https://github.com/google/pebble/blob/main/docs/pulse2/reliable-transport.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4354
} |
# pblprog
Utility for flashing Pebble BigBoards over SWD
Installation
------------
Install from PyPi (https://pebbletechnology.atlassian.net/wiki/display/DEV/pypi) under the package name `pebble.programmer`.
Supported devices
-----------------
It is relatively easy to add support for any STM32/SWD based Pebble BigBoard. Currently supported are:
- silk_bb
- robert_bb | {
"source": "google/pebble",
"title": "python_libs/pblprog/README.md",
"url": "https://github.com/google/pebble/blob/main/python_libs/pblprog/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 374
} |
# pyegg-pebble-loghash
A python egg for dealing with hashed TinTin logs | {
"source": "google/pebble",
"title": "python_libs/pebble-loghash/README.md",
"url": "https://github.com/google/pebble/blob/main/python_libs/pebble-loghash/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 71
} |
pebble.pulse2
=============
pulse2 is a Python implementation of the PULSEv2 protocol suite.
https://pebbletechnology.atlassian.net/wiki/display/DEV/PULSEv2+Protocol+Suite | {
"source": "google/pebble",
"title": "python_libs/pulse2/README.rst",
"url": "https://github.com/google/pebble/blob/main/python_libs/pulse2/README.rst",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 173
} |
# libOS
libOS is a helper library that makes developing software on top of FreeRTOS on ARM easier.
It is used by and built for the main FW and the Dialog Bluetooth FW.
## Dependencies:
- libc
- libutil
- FreeRTOS
- Availability of an <mcu.h> header file that includes the CMSIS headers (core_cmX.h,
core_cmFunc.h, etc.)
- A handful of platform specific functions, see platform.c | {
"source": "google/pebble",
"title": "src/libos/README.md",
"url": "https://github.com/google/pebble/blob/main/src/libos/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 383
} |
Header Overrides for Unit Tests
===============================
Writing a test which requires overriding a header?
--------------------------------------------------
1. Create a new override tree with versions of the headers you want to
override. Only the header files you add to this tree will shadow
default override headers and source-tree headers.
2. Create header files in subdirectories under this override tree so
that the relative paths to the override headers mirrors that of the
source tree. For example, if the header you want to override is
included by
```c
#include "applib/ui/ui.h"
```
then the override file should be placed in
`tests/overrides/my_override/applib/ui/ui.h`
3. Specify the override tree in your test's build rule.
```python
clar(ctx, ..., override_includes=['my_override'])
```
Guidelines for writing an override header
-----------------------------------------
### Never include function prototypes in an override header. ###
It is too easy to change a function prototype in a firmware header but
forget to mirror that change in an override header. Tests could start
erroneously failing when there is nothing wrong with the code, or
(worse) tests could erroneously pass when the code contains errors.
Refactor the header so that the header itself contains function
prototypes and the inline function definitions are placed in a separate
`header.inl.h` file. At the bottom of the header file,
```c
#include "full/path/to/header.inl.h"
```
and provide an override header for just `header.inl.h`. | {
"source": "google/pebble",
"title": "tests/overrides/README.md",
"url": "https://github.com/google/pebble/blob/main/tests/overrides/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1577
} |
# Contribution Guidelines
## Patch Submission Process
The following guidelines on the submission process are provided to help you be more effective when submitting code to the JerryScript project.
When development is complete, a patch set should be submitted via GitHub pull requests. A review of the patch set will take place. When accepted, the patch set will be integrated into the master branch, verified, and tested. It is then the responsibility of the authoring developer to maintain the code throughout its lifecycle.
Please submit all patches in public by opening a pull request. Patches sent privately to Maintainers and Committers will not be considered. Because the JerryScript Project is an Open Source project, be prepared for feedback and criticism-it happens to everyone-. If asked to rework your code, be persistent and resubmit after making changes.
### 1. Scope the patch
Smaller patches are generally easier to understand and test, so please submit changes in the smallest increments possible, within reason. Smaller patches are less likely to have unintended consequences, and if they do, getting to the root cause is much easier for you and the Maintainers and Committers. Additionally, smaller patches are much more likely to be accepted.
### 2. Sign your work with the JerryScript [Developer's Certificate of Origin](DCO.md)
The sign-off is a simple line at the end of the commit message of the patch, which certifies that you wrote it or otherwise have the right to pass it on as an Open Source patch. The sign-off is required for a patch to be accepted. In addition, any code that you want to contribute to the project must be licensed under the [Apache License 2.0](LICENSE). Contributions under a different license can not be accepted.
We have the same requirements for using the signed-off-by process as the Linux kernel.
In short, you need to include a signed-off-by tag in every patch.
You should use your real name and email address in the format below:
> JerryScript-DCO-1.0-Signed-off-by: Random J Developer [email protected]
"JerryScript-DCO-1.0-Signed-off-by:" this is a developer's certification that he or she has the right to submit the patch for inclusion into the project. It is an agreement to the JerryScript [Developer's Certificate of Origin](DCO.md). **Code without a proper signoff cannot be merged into the mainline.**
### 3. Open a GitHub [pull request](https://github.com/Samsung/jerryscript/pulls)
You can find instructions about opening a pull request [here](https://help.github.com/articles/creating-a-pull-request).
### 4. What if my patch is rejected?
It happens all the time, for many reasons, and not necessarily because the code is bad. Take the feedback, adapt your code, and try again. Remember, the ultimate goal is to preserve the quality of the code and maintain the focus of the Project through intensive review.
Maintainers and Committers typically have to process a lot of submissions, and the time for any individual response is generally limited. If the reason for rejection is unclear, please ask for more information from the Maintainers and Committers.
If you have a solid technical reason to disagree with feedback and you feel that reason has been overlooked, take the time to thoroughly explain it in your response.
### 5. Code review
Code review can be performed by all the members of the Project (not just Maintainers and Committers). Members can review code changes and share their opinion through comments guided by the following principles:
* Discuss code; never discuss the code's author
* Respect and acknowledge contributions, suggestions, and comments
* Listen and be open to all different opinions
* Help each other
Changes are submitted via pull requests and only the Maintainers and Committers should approve or reject the pull request (note that only Maintainers can give binding review scores).
Changes should be reviewed in reasonable amount of time. Maintainers and Committers should leave changes open for some time (at least 1 full business day) so others can offer feedback. Review times increase with the complexity of the review.
## Tips on GitHub Pull Requests
* [Fork](https://guides.github.com/activities/forking) the GitHub repository and clone it locally
* Connect your local repository to the original upstream repository by adding it as a remote
* Create a [branch](https://guides.github.com/introduction/flow) for your edits
* Pull in upstream changes often to stay up-to-date so that when you submit your pull request, merge conflicts will be less likely
For more details, see the GitHub [fork syncing](https://help.github.com/articles/syncing-a-fork) guidelines.
## How to add the DCO line to every single commit automatically
It is easy to forget adding the DCO line to the end of every commit message. Fortunately there is a nice way to do it automatically. Once you've cloned the repository into your local machine, you can add `prepare commit message hook` in `.git/hooks` directory like this:
```
#!/usr/bin/env python
import sys
commit_msg_filepath = sys.argv[1]
with open(commit_msg_filepath, "r+") as f:
content = f.read()
f.seek(0, 0)
f.write("%s\n\nJerryScript-DCO-1.0-Signed-off-by: <Your Name> <Your Email>" % content)
```
Please refer [Git Hooks](http://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for more information. | {
"source": "google/pebble",
"title": "third_party/jerryscript/CONTRIBUTING.md",
"url": "https://github.com/google/pebble/blob/main/third_party/jerryscript/CONTRIBUTING.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 5386
} |
# JerryScript Developer's Certificate of Origin
The JerryScript project uses the signed-off-by language and process to give us a clear chain of trust for every patch received.
> By making a contribution to this project, I certify that:
> (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
> (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
> (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
> (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project, under the same open source license.
We have the same requirements for using the signed-off-by process as the Linux kernel.
In short, you need to include a signed-off-by tag in the commit message of every patch.
You should use your real name and email address in the format below:
> JerryScript-DCO-1.0-Signed-off-by: Random J Developer [email protected]
"JerryScript-DCO-1.0-Signed-off-by:" this is a developer's certification that he or she has the right to submit the patch for inclusion into the project. It is an agreement to the Developer's Certificate of Origin (above). **Code without a proper signoff cannot be merged into the mainline.** | {
"source": "google/pebble",
"title": "third_party/jerryscript/DCO.md",
"url": "https://github.com/google/pebble/blob/main/third_party/jerryscript/DCO.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1846
} |
# JerryScript: JavaScript engine for the Internet of Things
[](LICENSE)
[](https://travis-ci.org/Samsung/jerryscript)
JerryScript is a lightweight JavaScript engine for resource-constrained devices such as microcontrollers. It can run on devices with less than 64 KB of RAM and less than 200 KB of flash memory.
Key characteristics of JerryScript:
* Full ECMAScript 5.1 standard compliance
* 160K binary size when compiled for ARM Thumb-2
* Heavily optimized for low memory consumption
* Written in C99 for maximum portability
* Snapshot support for precompiling JavaScript source code to byte code
* Mature C API, easy to embed in applications
Additional information can be found on our [project page](http://jerryscript.net) and [Wiki](https://github.com/Samsung/jerryscript/wiki).
IRC channel: #jerryscript on [freenode](https://freenode.net)
Mailing list: [email protected], you can subscribe [here](https://mail.gna.org/listinfo/jerryscript-dev) and access the mailing list archive [here](https://mail.gna.org/public/jerryscript-dev).
## Quick Start
### Getting the sources
```bash
git clone https://github.com/Samsung/jerryscript.git
cd jerryscript
```
### Building JerryScript
```bash
python tools/build.py
```
For additional information see [Getting Started](docs/01.GETTING-STARTED.md).
## Documentation
- [Getting Started](docs/01.GETTING-STARTED.md)
- [API Reference](docs/02.API-REFERENCE.md)
- [API Example](docs/03.API-EXAMPLE.md)
- [Internals](docs/04.INTERNALS.md)
## Contributing
The project can only accept contributions which are licensed under the [Apache License 2.0](LICENSE) and are signed according to the JerryScript [Developer's Certificate of Origin](DCO.md). For further information please see our [Contribution Guidelines](CONTRIBUTING.md).
## License
JerryScript is Open Source software under the [Apache License 2.0](LICENSE). Complete license and copyright information can be found in the source code.
> Copyright 2015 Samsung Electronics Co., Ltd.
> 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. | {
"source": "google/pebble",
"title": "third_party/jerryscript/README.md",
"url": "https://github.com/google/pebble/blob/main/third_party/jerryscript/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2749
} |
Contributing to Nanopb development
==================================
Reporting issues and requesting features
----------------------------------------
Feel free to report any issues you see or features you would like
to see in the future to the Github issue tracker. Using the templates
below is preferred:
* [Report a bug](https://github.com/nanopb/nanopb/issues/new?body=**Steps%20to%20reproduce%20the%20issue**%0a%0a1.%0a2.%0a3.%0a%0a**What%20happens?**%0A%0A**What%20should%20happen?**&labels=Type-Defect)
* [Request a feature](https://github.com/nanopb/nanopb/issues/new?body=**What%20should%20the%20feature%20do?**%0A%0A**In%20what%20situation%20would%20the%20feature%20be%20useful?**&labels=Type-Enhancement)
Requesting help
---------------
If there is something strange going on, but you do not know if
it is actually a bug in nanopb, try asking first on the
[discussion forum](https://groups.google.com/forum/#!forum/nanopb).
Pull requests
-------------
Pull requests are welcome!
If it is not obvious from the commit message, please indicate the
same information as you would for an issue report:
* What functionality it fixes/adds.
* How can the problem be reproduced / when would the feature be useful. | {
"source": "google/pebble",
"title": "third_party/nanopb/CONTRIBUTING.md",
"url": "https://github.com/google/pebble/blob/main/third_party/nanopb/CONTRIBUTING.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1224
} |
Nanopb - Protocol Buffers for Embedded Systems
==============================================
Nanopb is a small code-size Protocol Buffers implementation in ansi C. It is
especially suitable for use in microcontrollers, but fits any memory
restricted system.
* **Homepage:** https://jpa.kapsi.fi/nanopb/
* **Git repository:** https://github.com/nanopb/nanopb/
* **Documentation:** https://jpa.kapsi.fi/nanopb/docs/
* **Forum:** https://groups.google.com/forum/#!forum/nanopb
* **Stable version downloads:** https://jpa.kapsi.fi/nanopb/download/
* **Pre-release binary packages:** https://github.com/nanopb/nanopb/actions/workflows/binary_packages.yml
Using the nanopb library
------------------------
To use the nanopb library, you need to do two things:
1. Compile your .proto files for nanopb, using `protoc`.
2. Include *pb_encode.c*, *pb_decode.c* and *pb_common.c* in your project.
The easiest way to get started is to study the project in "examples/simple".
It contains a Makefile, which should work directly under most Linux systems.
However, for any other kind of build system, see the manual steps in
README.txt in that folder.
Generating the headers
----------------------
Protocol Buffers messages are defined in a `.proto` file, which follows a standard
format that is compatible with all Protocol Buffers libraries. To use it with nanopb,
you need to generate `.pb.c` and `.pb.h` files from it:
python generator/nanopb_generator.py myprotocol.proto # For source checkout
generator-bin/nanopb_generator myprotocol.proto # For binary package
(Note: For instructions for nanopb-0.3.9.x and older, see the documentation
of that particular version [here](https://github.com/nanopb/nanopb/blob/maintenance_0.3/README.md))
The binary packages for Windows, Linux and Mac OS X should contain all necessary
dependencies, including Python, python-protobuf library and protoc. If you are
using a git checkout or a plain source distribution, you will need to install
Python separately. Once you have Python, you can install the other dependencies
with `pip install --upgrade protobuf grpcio-tools`.
You can further customize the header generation by creating an `.options` file.
See [documentation](https://jpa.kapsi.fi/nanopb/docs/concepts.html#modifying-generator-behaviour) for details.
Running the tests
-----------------
If you want to perform further development of the nanopb core, or to verify
its functionality using your compiler and platform, you'll want to run the
test suite. The build rules for the test suite are implemented using Scons,
so you need to have that installed (ex: `sudo apt install scons` or `pip install scons`).
To run the tests:
cd tests
scons
This will show the progress of various test cases. If the output does not
end in an error, the test cases were successful.
Note: Mac OS X by default aliases 'clang' as 'gcc', while not actually
supporting the same command line options as gcc does. To run tests on
Mac OS X, use: `scons CC=clang CXX=clang`. Same way can be used to run
tests with different compilers on any platform.
For embedded platforms, there is currently support for running the tests
on STM32 discovery board and [simavr](https://github.com/buserror/simavr)
AVR simulator. Use `scons PLATFORM=STM32` and `scons PLATFORM=AVR` to run
these tests.
Build systems and integration
-----------------------------
Nanopb C code itself is designed to be portable and easy to build
on any platform. Often the bigger hurdle is running the generator which
takes in the `.proto` files and outputs `.pb.c` definitions.
There exist build rules for several systems:
* **Makefiles**: `extra/nanopb.mk`, see `examples/simple`
* **CMake**: `extra/FindNanopb.cmake`, see `examples/cmake`
* **SCons**: `tests/site_scons` (generator only)
* **Bazel**: `BUILD` in source root
* **Conan**: `conanfile.py` in source root
* **PlatformIO**: https://platformio.org/lib/show/431/Nanopb
* **PyPI/pip**: https://pypi.org/project/nanopb/
* **vcpkg**: https://vcpkg.info/port/nanopb
And also integration to platform interfaces:
* **Arduino**: http://platformio.org/lib/show/1385/nanopb-arduino | {
"source": "google/pebble",
"title": "third_party/nanopb/README.md",
"url": "https://github.com/google/pebble/blob/main/third_party/nanopb/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4364
} |
TimeShift.js
============
TimeShift.js allows mocking / overriding JavaScript's Date object so that you can set the current time and timezone. It is meant for creating repeatable tests that utilize the current time or date.
Usage
-----
```javascript
new Date().toString(); // Original Date object
"Fri Aug 09 2013 23:37:42 GMT+0300 (EEST)"
Date = TimeShift.Date; // Overwrite Date object
new Date().toString();
"Fri Aug 09 2013 23:37:43 GMT+0300"
TimeShift.setTimezoneOffset(-60); // Set timezone to GMT+0100 (note the sign)
new Date().toString();
"Fri Aug 09 2013 21:37:44 GMT+0100"
TimeShift.setTime(1328230923000); // Set the time to 2012-02-03 01:02:03 GMT
new Date().toString();
"Fri Feb 03 2012 02:02:03 GMT+0100"
TimeShift.setTimezoneOffset(0); // Set timezone to GMT
new Date().toString();
"Fri Feb 03 2012 01:02:03 GMT"
TimeShift.getTime(); // Get overridden values
1328230923000
TimeShift.getTimezoneOffset();
0
TimeShift.setTime(undefined); // Reset to current time
new Date().toString();
"Fri Aug 09 2013 20:37:45 GMT"
new Date().desc(); // Helper method
"utc=Fri, 09 Aug 2013 20:37:46 GMT local=Fri, 09 Aug 2013 20:37:46 GMT offset=0"
new TimeShift.OriginalDate().toString(); // Use original Date object
"Fri Aug 09 2013 23:37:47 GMT+0300 (EEST)"
```
Time zones
----------
TimeShift.js always utilizes its internal time zone offset when converting between local time and UTC. The offset factor is fixed, and it does not take into account DST changes. Effectively it emulates a time zone with no DST.
```javascript
new Date(1370034000000).toString(); // Original Date object uses variable offset
"Sat Jun 01 2013 00:00:00 GMT+0300 (EEST)"
new Date(1356991200000).toString();
"Tue Jan 01 2013 00:00:00 GMT+0200 (EET)"
Date = TimeShift.Date; // TimeShift.js uses fixed offset
new Date(1370034000000).toString();
"Sat Jun 01 2013 00:00:00 GMT+0300"
new Date(1356991200000).toString();
"Tue Jan 01 2013 01:00:00 GMT+0300"
```
The default time zone offset is the current local time zone offset. Note that this can change depending on local DST. Setting the time zone offset affects also previously created Date instances.
The time zone offset has the same sign as [Date.getTimezoneOffset](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset). For example, -120 is GMT+0200 and +120 is GMT-0200.
Caveats
-------
The mock implementation of Date is not perfect.
* Many string-generation methods are incomplete and return something indicative, but not fully correct. In particular `toDateString`, `toLocaleDateString`, `toLocaleString`, `toLocaleTimeString`, `toTimeString` produce somewhat incorrect results.
* The `toString` method does not contain any time zone name.
* The `parse` method delegates directly to the original method and may not handle time zones correctly.
* DST changes cannot be emulated. The time zone offset it always fixed.
* If a library or other code holds an original Date object or a reference to the Date prototype, things may break (e.g. error messages like "this is not a Date object"). In this case you should overwrite the Date object before loading the library.
If you'd like to fix some of these issues, please fork the repository, implement the desired functionality, add unit tests to `tests.js` and send a pull request.
License
-------
TimeShift.js is Copyright 2013 Mobile Wellness Solutions MWS Ltd and Sampo Niskanen.
It is released under the MIT license. | {
"source": "google/pebble",
"title": "third_party/timeshift-js/README.md",
"url": "https://github.com/google/pebble/blob/main/third_party/timeshift-js/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 3660
} |
Pebble Font Renderer Script
===========================
These Python scripts take TrueType font files, renders a set of glyps and outputs them into .h files in the appropriate structure for consumption by Pebble's text rendering routines.
Requirements:
-------------
* freetype library
* freetype-py binding
http://code.google.com/p/freetype-py/
**Mac OS X and freetype-py**: the freetype binding works with the Freetype library that ships with Mac OS X (/usr/X11/lib/libfreetype.dylib), but you need to patch setup.py using this diff file:
https://gist.github.com/3345193 | {
"source": "google/pebble",
"title": "tools/font/README.md",
"url": "https://github.com/google/pebble/blob/main/tools/font/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 577
} |
# Tintin Native SDK Generator
This script exports white-listed functions, `typedef`s and `#define`s in tintin source tree so that they can be used by native-watch apps.
>
> ### Note:
>
> It is *not* possible to add additional publicly exposed functions to
> an already released firmware/SDK combination.
>
> This is because the generated `src/fw/pebble.auto.c` file needs
> to have been compiled into the firmware with which the SDK will be
> used.
>
> If you just expose a new function in `exported_symbols.json`,
> generate a new SDK and compile an app that uses the new function
> then the watch will crash when that code is executed on a firmware
> without that function exposed.
>
> You will need to generate and release a new firmware alongside the
> new SDK build that has the newly exposed function.
>
The script generates 3 files required to build native watchapps:
+ `sdk/include/pebble.h` -- Header file containing the typedefs, defines and function prototypes for normal apps
+ `sdk/include/pebble_worker.h` -- Header file containing the typedefs, defines and function prototypes for workers
+ `sdk/lib/pebble.a` -- Static library containing trampolines to call the exported functions in Flash.
+ `src/fw/pebble.auto.c` -- C file containing `g_pbl_system_table`, a table of function pointers used by the trampolines to find an exported function's address in Flash.
## Running the generator
The running of the generator has now been integrated into the build, so there is no need to run it separately.
If for whatever reason, you need to run the generator by hand, run `% tools/generate_native_sdk/generate_pebble_native_sdk_files.py --help`, and it's simple enough to follow.
## Configuration
The symbols exported by the SDK generator are defined in the `exported_symbols.json` config file.
The format of the config file is as follows:
[
{
"revision" : "<exported symbols revision number>",
"version" : "x.x",
"files" : [
<Files to parse/search>
],
"exports" : [
<Symbols to export>
]
}
]
Each exported symbol in the `exports` table is formatted as follows:
{
"type" : "<Export type",
"name" : "<Symbol name>",
"sortName" : "<sort order>",
"addedRevision" : "<Revision number>"
}
`Export type` type can be any of `function`, `define`, `type`, or `group`. A `group` type has the following structure:
{
"type : "group",
"name" : "<Group Name>",
"exports" : [
<Symbols to export>
]
}
*NB:* The generator sorts the order of the `functions` in order of addedRevision, and then alphabetically within a revision using sortName (if specified) or name. The `types` fields are left in the order in which they are entered in the types table. As well, Be sure to specify any typedefs with dependencies on other typedefs after their dependencies in the `types` list.
### Important!
When adding new functions, make sure to bump up the `revision` field, and use that value as the new functions' `addedRevision` field. This guarantees that new versions of TintinOS are backwards compatible when compiled against older `libpebble.a`. Seriously, ***make sure to do this***!!.
## Bugs
+ The script doesn't check the the resulting `pebble.h` file will compile, that is left as an exercise to the reader.
+ The script's error reporting is a little funky/unfriendly in places
+ The script does not do any checking of the function revision numbers, beyond a simple check that the file's revision is not lower than any function's. | {
"source": "google/pebble",
"title": "tools/generate_native_sdk/README.md",
"url": "https://github.com/google/pebble/blob/main/tools/generate_native_sdk/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 3652
} |
Resource Generation
===================
The old resource code was crazy and slow. Let's redesign everything!
Design Goals
------------
1. Decouple processing different types of resources from each other into their own files
2. Be completely SDK vs Firmware independent. Any differences in behaviour between the two resource
generation variants should be captured in parameters as opposed to explicitly checking which
one we are.
3. No more shelling out
4. Capture as much intermediate state in the filesystem itself as possible as opposed to
generating large data structures that need to be done on each build.
5. Remove the need to put dynamically generated resource content like the bluetooth patch and
stored apps into our static resource definition json files for more modularity. | {
"source": "google/pebble",
"title": "tools/resources/README.md",
"url": "https://github.com/google/pebble/blob/main/tools/resources/README.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 798
} |
---
# 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
title: Pebble SDK 2.0 BETA0 - Changelog
date: 2013-11-01
---
This version is a preview of what will be publicly released soon as a BETA. This means that it is the last time we introduce large changes to the APIs, they will be much more stable in the future.
It includes some last significant changes that will impact every application.
* We have changed the format of the `wscript` file. **You must update your wscript file.** The easiest way to do this is to generate a new project with `pebble new-project` and use the generated `wscript`.
* Header files `pebble_os.h`, `pebble_app.h` and `pebble_fonts.h` are replaced by `pebble.h`
* `click_config_provider()` signature has changed and instead of filling a struct, you call `window_*_click_subscribe`. Please refer to the [Migration Guide](/guides/migration/).
* On AppMessage:
* We have changed the signature of most AppMessage functions. Please refer to the [Migration Guide](/guides/migration/).
* We have added functions to query the size of the AppMessage buffers. They still return the same value that in previous versions ... for now.
* We have added a [Mobile Developer Guide](/guides/communication/) covering PebbleKit iOS and Android. Please take a look at them, they should answer lots of questions.
* [PebbleKit Android Documentation](/guides/communication/using-pebblekit-android) is now available on the website and in the SDK `Documentation` folder.
* We have done a lot of work on PebbleKit JavaScript:
* The [documentation](/guides/communication/using-pebblekit-js) describes the new model for loading and stopping JavaScript apps. You should take a look.
* On Android only (for now) apps will automatically start when they get a message from Pebble.
* On Android only (for now) you can use the gear icon to open a configuration window on the phone.
* You can now call `Pebble.addEventListener` instead of `PebbleEventListener.addEventListener`
* DataLogging is now supported on Android, iOS6 and iOS7
* And of course we have fixed a large quantities of bugs.
This is a private release under NDA. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA0.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA0.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2698
} |
---
# 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.
title: Pebble SDK 2.0 BETA1 - Changelog
date: 2013-11-06
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* SDK 2.0 will be released later this year as an over-the-air update to all Pebble users.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
* ANCS Notifications (aka BLE notifications) are not supported for iOS users in this version
Updates:
* 2013 11 07: Added a firmware for watch with serial number starting with a 'Q' (aka hardware 1.5)
## What has changed since BETA0
### User Bug Fixes and Feature Enhancements
- Fixed crashing bugs on the iOS app. Users should experience improved stability.
- New iOS users no longer need to manage access to their address book in order to see Caller ID on their Pebble.
- The iOS app does not overflow the banner bar (at the top of the screen) on iOS7
- The Pebble now can show >80 unread notifications, up from 8 previously.
- Backlight is triggered on a tap from any of the 6 axes of the watch
- Android app stability has been improved
- On Android, switching orientation while updating firmware does not stop the firmware update
- The music app now stays open rather than switching back to the menu after 1 minute
### Known User Issues
- The status indication button in the main screen sometimes repeatedly throbs green then red, repeatedly.
- (iOS7 users, iPhone4S and higher) If you select "Enable Notifications" and select the Cancel button in the system alert that comes up, it can take up to 30 seconds for the iOS app to allow selection of "Enable Notifications" again. As a workaround, if you launched this screen from the Status screen, you can hit the up arrow, then the red "Not receiving notifications" button, and retry enabling notifications again.
- In certain conditions if you enable and disable Airplane mode on your Pebble, you may need to restart the Pebble iOS app completely in order to re-enable notifications again
- On Android, you may need to restart the Pebble app after installing a new version of a JavaScript app to ensure that your changes are successfully loaded.
- On Android, use of HTML5 local storage does not guarantee data will be saved across sessions.
- Duplicate APP_LOG messages can be received while using the pebble tool; these are intermittent and developers should use timestamps to identify duplicates
- If there is not enough app heap remaining, some essential functions that allocate on that heap will fail, such as system fonts or persistent storage
- The iOS app can sometimes crash when opening a PBW file if it is not already running
### Developer Bug Fixes and Enhancements (Major Feature Enhancements are covered in the SDK)
- Apps now only need one Pebble specific header, pebble.h
- Exiting an app showing no windows will now not crash the Pebble
- Pebble will not crash when cancelling an already cancelled timer
- Pebble will not crash when cancelling an unregistered timer
- Holding the up or down buttons now cause repeated clicks in menus
- Changed the default stroke color to Black instead of White, as the default background color is White
- Apps now cannot overwrite the system memory, and will be terminated if they attempt to
- Int type changes on many APIs to ensure future compatability
- User data can be attached to a window
- The pebble tool displays an error message if you try to install an application that is not compatible with the target firmware
- The menu icon resource is displayed even if it is not the first resource
- Libpebble times out if no apps are installed
- The valid range for UUIDs has changed - see the developer documentation
- The Android app now installs bundles in Gmail attachments
- System fonts now show capital W, Q and O
- `pebble Install`` will now install even if the Android app is left in the “Update” screen
- Apps will not crash if a text layer is not large enough to hold the requested text
- `pebble install --logs` proceeds to tail logs even when install fails
- Apps will not crash when popping/removing already popped/removed windows from the stack | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4688
} |
---
# 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.
title: Pebble SDK 2.0 BETA2 - Changelog
date: 2013-11-14
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* SDK 2.0 will be released later this year as an over-the-air update to all Pebble users.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
## What has changed since BETA1
Overview:
- We have included ANCS in 2.0 - iOS users will get all notifications
- We have added a screenshot tool
- We have increased the AppMessage buffer size for PebbleKit JS Apps
- We have changed a few firmware APIs to always pass parameter in this order: (buffer, size)
- We have fixed many bugs
Known problems and bugs:
- We are still working actively on improving datalogging on iOS and Android. If you wish to use this framework, please get in touch with us and tell us about your experience.
- JavaScript apps on Android will only run if the phone is turned on and the Pebble app running (the easiest way to check this is to bring it to the foreground). This will be fixed soon.
- If you downloaded the SDK before 5pm PST on 2013-11-14, your API documentation is probably broken. We have fixed this and pushed a new release without updating the version number because there are absolutely no changes (except the doc is now there ;).
### Firmware
- Added support for ANCS
- Fix UI bug when getting phone calls
- Improved address book lookups when getting phone calls
- Changed the behaviour when an app is closed from PebbleKit: return to the last running app or watchface (instead of the launcher)
- Show malloc and free in the generated documentation
- Fix doc for AccelAxisType
- Do not animation a window disappearing if the window was pushed without animation
- Add `GCornersRight` in the documentation of `GCornerMask`
- Document `GTextOverflowMode`
- Document the return value of the `persist_*` functions
- Document `AppTimerCallback`
- When exiting an app, all unload handlers will be called for loaded windows
- Changed the order of parameters for `persist_read_data()`, `persist_read_string()`, `persist_write_data()`, `dict_calc_buffer_size()`, `dict_serialize_tuplets_to_buffer_with_iter()`: always ask for the pointer first and then the count or size
- Fix bug where the status bar would not be displayed properly
- Enabled Accelerometer high resolution output
- Automatically reset the accelerometer when app exits
- Removed the 1Hz accelerometer settings because it breaks the shake to backlight - Use peek() instead if you only need one sample per second.
- Updated the guaranteed minimum buffer sizes for appmessage. They are in fact 124 / 636.
- Fix bug where appLaunch commands would not be ACK'd
- Increased AppMessage buffer sizes for JavaScript apps: they get 2k in and out.
### iOS App
- Fixed several dataLogging bugs
- Fixed most common crashes reported by TestFlight
### Android App
- Fixed several dataLogging bugs
- Fixed most common crashes reported by TestFlight
### PebbleKit iOS
- DataLogging apps do not need to include an `appInfo.json` file anymore
- Use `setAppUUID` to give the UUID of the app you want to talk to
### PebbleKit Android
- Add `getWatchFWVersion()` to get a `FirmwareVersionInfo` object
- Add `isDataLoggingSupported`
### SDK Tools
- Added a `screenshot` command to the `pebble` tool
- Revert the change in the tool where we would enforce a specific range of uuids
- Improved error messages when the tools cannot be found
- Do not truncate log messages coming from the JavaScript console
- Only log app_log (and not system log) by default. Use `--verbose` to get all the logs.
### Examples
- Fix a bug in the dataspooling demo where sealions and pelicans got mixed up
- Fix PebbleKit Examples for the new `setAppUUID` style
- Fix examples to use the new parameter orders for `persist` functions | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4428
} |
---
# 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.
title: Pebble SDK 2.0 BETA3 - Changelog
date: 2013-12-12
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* SDK 2.0 will be released later this year as an over-the-air update to all Pebble users.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
* If a 2.0 version of an application exists, the Pebble mobile applications will automatically install it when when a user upgrades her/his Pebble.
## What has changed since BETA2
Overview:
- The Android app fixes a large number of JS-related bugs.
- The Android app fixes a bug where all messages sent to android would be automatically acknowledged. Your application should acknowledge app messages.
- Some new user features in the firmware: Notification settings (with Do Not Disturb), better Alarms
- Lots of small UI and stability fixes in Pebble.
Known problems and bugs:
### Firmware
- added a Notification menu in the Settings to disable Notifications and configure a DoNotDisturb time frame
- much better Alarm app with a nicer UI, snooze support, disabled alarms support
- fix bugs where incoming calls could cause the vibration to stay on continuously
- fix a rare condition where the accelerometer would crash if an interrupt comes too late or the accelerometer sent 0 samples
- fix accelerometer behaviour when only 1 sample is requested: only send one sample (instead of 2)
- fix a bug where an iOS device could disconnect just 1-2 seconds after connecting
- automatically reconnect when user leaves Airplane Mode
- show (in settings) that vibrations are disabled when Pebble is plugged
- improved the set date/time UI to use the new DateTime UI (as in Alarms)
- adjust the framebuffer offset for modal window transitions
- reduced BLE connection interval
- log more information when an application crashes
- do not crash if an app_message section is re-opened - display warning instead
- fix a bug which caused firmware updates to fail under some conditions (mostly android)
- appsync will only update a dictionary if it has enough memory to do so (instead of finding out half-way that it does not have enough memory)
- always return to the launcher after an app crash (to avoid a crash loop on a watchface)
- *_destroy() will accept NULL pointers without errors
- always go back to the top of the menu when launching the menu from a watchface (to make "blind" navigation easier)
- fix a bug where an actionbar button would still be "pressed"
- show Bluetooth Name on getting started screen
- automatically delete old apps that are not compatible with this firmware version
- accelerate scrolling on the menu
- use modal window icon in the status bar as long as the modal window is displayed
- Export dict_size so external developers don't have to do pointer math :)
- fix a bug where scrolling in a long list of notifications could cause the display to "bounce"
- fix a bug where lots of app logging messages could overflow the system task queue and kill app message
- API documentation completely reviewed and updated
- missed call modal views will timeout after 180s
- force quit app when the back button is held for 2 seconds
- menu_cell_basic_draw() now automatically center the text in the cell. If you do not want a subtitle, pass NULL (otherwise, space will be reserved for the subtitle).
- fixed some bluetooth settings to avoid duplicated messages (could cause screenshot to go over 100%, duplicated log entries, firmware upgrade to fail, etc)
- `peek()`ing the accelerometer is not allowed anymore when you have also subscribed to receive updates
- fix a bug where the accelerometer would get stuck after a few hours
### iOS App
- fix a bug where datalogging could dump messages to another phone on your local network
- fix a bug where datalogging would get into a deadlock
- fix a bug where the developer connection would appear active but would be closed
### Android App
- fix a number of cases where a JS app would not be launched
- fix bug where clicking the configure icon would not open the configuration view of an app
- fix a bug which caused every AppMessage sent to Android to be acknowledged by the system
- Select the Google Play Music App as the default music player
- fix support email to use the Pebble bluetooth name instead of the last four digits of the serial
- if there is an error when uploading an app, do not dismiss the update screen right away
- do not dump large logs if stats json is not found
- check for firmware update when foregrounded
- fix bug where a canceled app install would be reported as completed
- fix bug where an install would fail silently because the resources could not be loaded
- display specific error message when a user tries to install a 2.0 app on a 1.x Pebble
- fix a bug where the android app would display error message "Could not update" while looking for updates in the background
### PebbleKit iOS
- allow one iOS application to exchange messages with several Pebble apps (with different UUIDs)
- fix a crash trying to parse invalid firmware version
- add CocoaPods support (see pebblekit-ios readme for more info)
- enabled "all warnings" and fixed errors
### PebbleKit Android
No changes.
### SDK Tools
- added support to upload any bundle (including firmware)
- added test to detect missing tools
- better implementation of the --debug flag
- fix bug where tools would fail when installed in a folder with a space in it
- fix bug where tools would fail on project with a space in the name
- some 1.x to 2.x conversion bugs fixed
- automatically re-enable applog when the watch reconnects
### Examples
- fix crashing bugs in 91Dub | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA3.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA3.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 6276
} |
---
# 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.
title: Pebble SDK 2.0 BETA4 - Changelog
date: 2013-12-23
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* SDK 2.0 will be released early next year as an over-the-air update to all Pebble users.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
* If a 2.0 version of an application exists, the Pebble mobile applications will automatically install it when when a user upgrades her/his Pebble.
**You can start uploading your application to the Pebble appstore TODAY - [Please do so](http://dev-portal.getpebble.com/)!**
## What has changed since BETA3
Overview:
- Fixed a problem where the iOS app would get killed after a few minutes in the background
- Lots of Data Logging fixes on the firmware and on Android
- Added timestamps on accelerometer samples
- Improved error handling for PebbleKit JS apps on iOS and Android
### Firmware
- Developers of apps can now register single and multi click handlers on the back button
- Holding down the back button for 1.5s will force quit an existing app
- Fixed bugs and optimize the filesystem: faster persist times, less problems with persistent storage, fix a bunch of rather complex problems where the recovery firmware could be damaged
- Fixed scroll offset bug when displaying notifications
- Dismiss missed call notfication after 180s
- Fixed a bug where unicode characters were not supported in appinfo.json
- Changed graphics_text_layout_get_max_used_size() to _not_ require a graphic context
- Fixed a few more bluetooth bugs
- Fixed a bug where Pebble could crash when you delete the last alarm
- Fixed memory read exception that can occur when using a malloc-ed appsync buffer
- Save notifications to storage during do not disturb
- Document AccelAxisType in API Documentation
- Fixed Music UI problems
- Automatically center on screen a selected cell in a SimpleMenuLayer
- Fixed bug where snprintf could crash the watch
- Display an error message if a 2.0 pebble is connected to a 1.x mobile app
- Fixed a bug where calling atoi() would crash an app
- Many DataLogging improvements and fixes based on new unit tests
- Display an alert on Pebble when we reset due to a system crash
- Ignore NULL pointer passed to text_layer_destroy()
- Limit the number of datalogging sessions to 20
- Fixed a race condition that occurs when you set the sampling rate immediately after subscribing to the accel service
- Keep persistent storage intact when upgrading an application
- Added timestamps on accelerometer samples and a flag indicating if the watch was vibrating at the time of the sample
- Fixed a bug where psleep could crash pebble
- Fixed a bug where text_layer could add ellipsis to the wrong line
### iOS App
- Fixed a bug where the iOS app would get killed in the background after just a few minutes
- Show a local notification if a developer is connected but the app is about to get killed
- PebbleKit JS: Fixed a bug where apps could not access localStorage with the array syntax
- PebbleKit JS: Fixed a bug where a space in an URL opened with XmlHTTPRequest could crash the iOS app
- PebbleKit JS: Fixed a bug where sending a byte array with 0xff in it would send 0x00 instead
### Android App
- PebbleKit JS: Fixed a bug where a byte array would not be sent properly for named keys
- Use new Android KitKat (4.4) APIs to do pairing on 4.4
- PebbleKit JS: Do not send ack for ack/nack messages
- Fixed Android crashing with OutOfMemory error when using Data Logging
- Fixed Android Data Logging of byte array that was not working
### PebbleKit iOS
- Do not ack ACKs...
### PebbleKit Android
- No changes
### SDK Tools
- Added support to libpebble to trigger reboot to recovery firmware
- Added support for computers where python2 and python3 co-exist
- Fixed an exception when receiving APP_LOG with extended characters
- Fixed a bug where unicode characters were not supported in characterRegex field of `appinfo.json`
- Fixed 30 second delay that can occur when building pebble apps on Ubuntu when there is no internet access
- Added Pillow python dependency: needed for the screenshot functionality
- Detect PIL/Pillow conflict and suggest a fix to the user
### Examples
- Added a License to the examples | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA4.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA4.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4868
} |
---
# 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.
title: Pebble SDK 2.0 BETA5 - Changelog
date: 2014-01-10
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
* If a 2.0 version of an application exists, the Pebble mobile applications will automatically install it when when a user upgrades her/his Pebble.
**You can start uploading your application to the Pebble appstore TODAY - [Please do so](http://dev-portal.getpebble.com/)!**
## What has changed since BETA4
Overview:
- Fixed Android datalogging bugs where data would get duplicated
- Merged datalogging fixes for iOS that were supposed to be in BETA4 (sorry)
- Added an end of session message on Android datalogging
- Fixed accelerometer bugs where the accelerometer would stop sending data
- Changed the animation when switching from one watchface to the next ...
- Changed the battery API to return values going up to 100%
### Known Problems and limitations
* **Accelerometer locking up**: Although we have fixed several bugs around the accelerometer, we have noticed a few instance of the accelerometer locking up and the accel callback not being called anymore. If you see this happen again, please use the "Contact Support" button to send us logs. Make sure you change the subject to "Accelerometer lockup". Thank you very much!
* `getAccountToken()` (in PebbleKit JS) is not working yet. It currently returns a random string. In an upcoming update (before 2.0) it will return a unique token linked to the Pebble user account.
This is tied with appstore functionnalities and not available yet in this beta build.
* Some crash due to internal timers and deadlock conditions are still being investigated.
* This version will reset your persistent storage when you install it
### Changes for Firmware:
- Added a script in the SDK to help analyze app memory usage (analyze_static_memory_usage)
- Changed the animation between watchfaces
- Fix various composition bugs during animations
- Several fix to the Pebble filesystem to fix problems occuring in persistent storage and datalogging
- Add `bitmap_layer_get_bitmap()`
- s/1 minutes/1 minute/ in the alarm app
- Do not crash when loading a font from a NULL resource (can happen when memory is tight!)
- Ignore buttons while animating from one window to another
- Fix the back button in the getting started
- Fix simplicity to show the time immediately
- Fix sliding text to animate the time in immediately
- Change simplicity to load the fonts as system fonts
- Invert modal window status bar icons
- Reworked `gpath_draw_filled()` to use less memory and use heap instead of stack
- Improve persistent storage behaviour under tight memory
- Enforce file size limits
- Improve number of sectors of the filesystem
- Fix a bug where in some condition going up and down after installing a watchface would not return to it
- Fix a bug where `text_layer_get_content_size()` could return values that caused the text to be truncated
- Do not crash in `gpath_draw_filled()` if called with 0 points
- Added event service unsubscribe for app_focus_event (fixes a crash for Glance and Upright)
- Changed the battery API to return values going up to 100%
### Changes for Pebble iOS App:
- Fixes to datalogging to avoid duplicated data and iOS app getting stuck
### Changes for Pebble Android App:
- Added an intent sent when a data logging session is finished
- Fix a problem where JavaScript would not start on android 4.0
- Fix some bluetooth scanning bugs that could cause timeouts or pebbles not detected
- Improved bluetooth pairing screens for various Android versions
### Changes for PebbleKit iOS:
- Fix some threading/deadlock bugs
### Changes for PebbleKit Android:
- Do not retransmit same datalogging blocks more than once
- Add a callback when the datalogging session is finished
### Changes for SDK Tools:
- Added command `pebble analyze-size` to dump sections and symbol sizes
- Increase timeout of the wsclient (could be triggered when installing firmware)
- Added `--simple` option to `pebble new-project` to create a minimalist app
- Updated to websocket-client 1.12 and removed dependency to io_sock
### Changes for Examples:
- Update classio-battery-connection example to peek() the bluetooth connection status at startup
### Changes for Documentation:
- Updated JS configuration example
- Added link to the pebble-hacks/configurable project in the JS doc
- Removed reference to the 1Hz acc sampling rate (RIP)
- Added an example use of the `pebble install` command in the example page
- Updated the `app_focus_subscribe` documentation in the event guide
- Added a note in the datalogging guide to mention it's not a realtime system
- Added doc for `only_shown_on_communication` in the anatomy of a pebble app chapter
- Added that you can call `app_message_outbox_begin` in `outbox_sent` and `outbox_failed` now
- Fixed formatting of the appinfo.json example in the anatomy of a pebble app chapter | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA5.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA5.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 5621
} |
---
# 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.
title: Pebble SDK 2.0 BETA6 - Changelog
date: 2014-01-17
---
* Pebble SDK 2.0 is currently in BETA and intended for developers only.
* Applications written for Pebble 1.x are not compatible with SDK 2.0
* If a 2.0 version of an application exists, the Pebble mobile applications will automatically install it when when a user upgrades her/his Pebble.
> **IMPORTANT NOTES FOR iOS Users**:
>
> * You must delete the Pebble app on your phone before installing this new version. It will now be called "Pebble Dev" and not "Pebble.". You must also re-install all of your JavaScript apps after installing this new version.
>
> * iPhone5S, iPad Air and Retina iPad Mini users will need to manually pair in the **Settings** of the phone.
## What has changed since BETA5
Overview:
- The iOS Application distributed with BETA6 includes the new Pebble appstore
- The firmware fixes a number of hard to reproduce crashes with system timers. This will fix a lot of the "Dangerously rebooting" Pebble crashes.
### Known Problems and limitations
* `getAccountToken()` (in PebbleKit JS) is not working yet. It currently returns a random string. In an upcoming update (before 2.0) it will return a unique token linked to the Pebble user account.
This is tied with appstore functionnalities and not available yet in this beta build.
* The bugs that were reported on datalogging-iOS on BETA5 are not fixed yet in this release
### Changes for Firmware:
* Rework the system timer to fix all timer related crashes
* Add support for Pebble Steel LED to show charging status
* Round rather than floor the battery charge percentage
* Reverted timings for stm32 for 64MHz system clock based on stable 16Hz SPI clock. Fixes display flicker at 30Hz, as well as saving power at the lower system clock (80->64) and sleeping more often due to faster display updates.
* Fix a crash when canceling the bluetooth pairing dialog
* Fix a bug where pushing a window in a window_unload callback would cause a crash
* Export AccelData structure in the API doc
* Vibrate when an app or watchface is installed
* Fix a bug where the phone modal window would not update properly
* Fix the light threshold for Pebble Steel
### Changes for Pebble iOS App:
* Added the Pebble appstore
* Added support for In-App Notifications
* Add support for migrating 1.x apps into 2.0 apps
* Fix a bug where the iOS app could crash when you switch away from a JavaScript app that has an ongoing network connection
* PebbleKit JS iOS: sendAppMessage() now returns a transaction id
### Changes for Pebble Android App:
* No changes.
### Changes for PebbleKit iOS:
* add isNewer convenience call to PBWatch+Version
* move NSJSONSerialization helper to PebbleVendor
* add isEqualVersionOnly to just compare version number components, ignoring timestamp & hash
### Changes for PebbleKit Android:
* No changes.
### Changes for SDK Tools:
* Fix spelling in an error message (s/Insure/Ensure/)
### Changes for Examples:
* No changes.
### Changes for Documentation:
* Fix a 404 on the pebble tool link in the JS guide
* Fix the persistence guide to reflect the new standardized parameters orders
* Fix a typo in the title of the UI framework guide
* Added designer resources in the UX design chapter | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA6.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA6.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 3868
} |
---
# 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.
title: Pebble SDK 2.0 BETA7 - Changelog
date: 2014-01-23
---
Pebble SDK 2.0 is still in BETA and is **recommended only** for developers working on new applications for the upcoming Pebble appstore.
## Update Jan 31st: 2.0 Release Candidate 3
We fixed two more crashes. iOS user will automatically get the update. Android users can download it from this site.
Not sending an email to everyone this time because it really is a small changes and we want to spare your inbox before the week-end.
## Update Jan 30th: 2.0 Release Candidate 2
On January 30th, we released a 2.0 Release Candidate version of the firmware with the following changes:
* fixes a number of crashes
* app no longer gets killed when it cancels an invalid timer
* removes “persist_raw -9” message
* low battery message always uses the right icon
* fixes crash on watch shutdown
* fixes crash when using accel
## Updated Jan 29th: 2.0 Release Candidate
On January 29th, we released a 2.0 Release Candidate version of the firmware with the following changes:
* Fixed numerous crashes
* %Z flag passed to strftime no longer crashes the watch
* Fixed iOS connected but not receiving anything issue
* Firmware will now delete all data logging data on factory reset
* Rate limit logging to prevent apps from crashing app with logging loops
* Fixed issues were buttons become unresponsive
* Fixed gpath getting clipped in some cases
* Fixed accel lockup issue
* Fixed accel not using the right sampling rate
* Added low battery warning
* Cancel snooze timer when alarm is deleted
Please continue using BETA7 versions of the SDK and mobile applications.
## What has changed since BETA6
Overview:
- More random crashes fixed in the firmware
- Seriously improved datalogging on iOS (and some bugfixes on Android)
- Fixed the URL scheme to install Pebble applications. It did not work in Beta6.
- Added support for `getAccountToken()` in PebbleKit JS (iOS only at the moment)
- iOS application and PebbleKit iOS are now 64 bits compatible
- iOS application does not crash on iPhone 4 anymore
- Some breaking changes in PebbleKit iOS: We cannot use NSNumber categories in 64 bit because their size is unknown. We added a new PBNumber class. This class is returned if you use the NSNumber Pebble category.
### Known Problems and limitations
- Android does not include the Pebble appstore yet
- PebbleKit iOS apps may see error messages about parsing firmware in their logs. This will be removed soon and does not impact anything in PebbleKit iOS.
### Changes for Firmware:
- fix bugs with modal windows over fullscreen apps
- fix bugs where action bar buttons could get "stuck"
- reduced the power used by Pebble Steel LEDs
- fix some data logging corruption issues on Pebble
- fix a bug where the time of a notification would not be displayed properly
- adjusted the battery charged thresholds so that Pebble Steel turns green when apps show 100%
- fix a bug where you could get 110% battery
- fix a bug where datalogging session could be incompletely initialized when pushed
- fix a bug that could happen when looking for notifications
- fix a bug where some original Pebbles (ev2_4) would never hit 100% battery
- fix infinite loop if you push a modal while one is closing
- fix some button problems on Pebble Steel
### Changes for Pebble iOS App:
- added support for 64bits compilation
- fix a bug where 64 bit devices would not display the bluetooth accessory picker
- native login / signup screen
- fix some button sizes to display text properly
- calculate the area of the buttons on the left menu to highlight them dynamically
- data logging: do not print error messages for partially fetched data - unless we are actually done
- fix some bugs around the Bluetooth accessory picker
- better management of the screens stack in onboarding process. allows users to go back.
- do not display icon for watchfaces in the my pebble screen
- fix bug where appstore url-scheme would not work
- add link to terms and conditions
- deal with timeout errors while installing apps
- downloading apps in the Caches directory instead of Documents since that one gets pruned automatically by the system (Fixes pebblekit#39)
- only allow to start dragging the center view if you start dragging from the left edge
- fix crash for iPhone 4 users
- fix bug where datalogging would try to send data to the Pebble app (instead of 3rd party apps)
- lazy loading the web appstore views to improve loading speed
- sort apps alphabetically in the locker
- memory optimization to stay in the background longer
- getAccountToken() now working in JavaScript
- fix a bug where the configuration view was not sometimes not dismissed
- rename the "Done" button of the configuration view to "Cancel"
- send empty string back to the JS if the user cancels the configuration view (as per documentation)
- only show the "notifications not set up" if there's a watch connected
- fix a JS bug where in some conditions the 'showConfiguration' event might be fired before the 'ready' event
### Changes for Pebble Android App:
- Datalogging: if a session contains bad data, just remove it at startup
### Changes for PebbleKit iOS:
- PebbleKit iOS is now 64 bits (armv7s) compatible
- We cannot use NSNumber categories in 64 bit because their size is unknown. We added a new PBNumber class. This class is returned if you use the NSNumber Pebble category.
- Do not start the datalogging server if appUUID is all zeros
### Changes for PebbleKit Android:
No changes.
### Changes for SDK Tools:
No changes.
### Changes for Examples:
- Classio-battery-connection is a watchface
- Onthebutton is a watchface
- Rumbletime is a watchface
- Fuzzy Time is a watchface
- Changed example UUID's to avoid appstore collisions
### Changes for Documentation:
- Add note about datalogging size | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-BETA7.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-BETA7.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 6463
} |
---
# 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.
title: Pebble SDK 2.0 DP2 - Changelog
date: 2013-09-24
---
>2.0 DP2.1
> We do not like making releases twice a week but we really wanted to fix the iOS/PebbleKit JS bug and so here it is. PebbleKit JS can now receive message on iOS and on Android. You only need to update your SDK for this to work. We will not release new versions of the mobile apps.
>The rest of the DP2 release notice below still applies.
### Known problems and bugs
- Data Logging does not work on iOS7
- The watch can run out of memory if the applications do not release the memory properly
- On iOS, PebbleKit JS can not receive app messages (fixed in the DP2.1 release)
### In a nutshell
* The format of applications has changed. Every application now requires an `appinfo.json` file in its base directory. This file contains the UUID, name and resources of the application. For PebbleKit JS apps, it may also contain the keys used for app_message communication.
* The `pb-sdk` tool is gone. It is replaced by the `pebble` command line.
* Instead of having the phone connect to the developer box, the developer tools will connect to the mobile application. When you turn on developer mode on your phone, it will display the IP address that you should use to connect to the phone. You can set a `PEBBLE_PHONE` environment variable to avoid retyping this all the time.
* Fixed most blocking bugs reported on Developer Preview 1 (details below)
* The Developer Guide has been completely rewritten and also includes a migration guide.
### Pebble Firmware
- Fixed a bug where launching an application through the bluetooth protocol would cause the app to be re-launched if it was already running.
- Added support for the middle button in the Golf app. This will send a message that is received by PebbleKit on iOS and Android.
- Tap event is now disabled during a vibration (to avoid triggering the event)
- Bumped firmware version and added tests to make sure that old apps will not run on the new firmware and vice-versa
- Fixed various issue with firmware updates
- AppLog does not need to be enabled manually anymore. It is automatically enabled by the `pebble` tool.
### Pebble SDK
- Finalized conversion to new dynamic memory model: all _init functions have been replaced by _create() equivalent that return a pointer to a newly allocated and initialized structure (gbitmap_init functions, gpath_init, property_animation_init and app_sync_init have been updated to the new style)
- Trigger a battery event when the percentage of battery charge changes (will trigger every 2%)
- Data Spooling now takes a `void*` pointer (to avoid useless casting in developer code)
- Data spooling session ids are now random
- persist_read_int now returns 0 if the key does not exist (as per documentation)
- Global static variables were not initialized properly
- Fix a dataspooling bug where sometimes the close message did not contain the correct session id
- Added a bluetooth_connection_service_peek() function
- Export atol/atoi functions
- Export app_comm_get_sniff_interval
- As a developer, I can call the atan()/atan2() function to compute an arc-tangent
- Renamed DataSpooling into DataLogging
- Defined a new Design Pattern to subclass layers and included an example based on the famous Progress Bar layer (`watchapps/feature_layer_data`)
### PebbleKit iOS/Android
- Redesigned completely the Android API for Data Logging (ex data spooling)
### PebbleKit JavaScript
- Fixed a bug where only single digit integers would be passed as integers
- On Android, the apps are now available in the "Webapps" menu
- On iOS and Android, applications will keep on running once they are started (but they do not start automatically yet)
- On iOS, you need to tap the appname to run it.
- On iOS, to allow for `openURL` to work, you need to open the javascript console first
- On iOS and Android, javascript `console.log` are sent over the developer connection (available with `pebble logs`)
- You can now send array of bytes by passing an array of integers to `sendAppMessage()`
- The keys in the appinfo.json file is now optional and you can use integers in strings as keys
- If a received message as a key that is not listed in the `appKeys` block, the integer will be converted to a string
- A bug where the navigation stack could be corrupted when calling `openURL` is fixed
### pb-sdk
- Renamed pb-sdk into pebble
- Added a --version option
- Added a command to clean current project
- Added an example of using APPLOG in the default generated project
- Return meaningful error codes to the shell
- Fixed a bug where `pb-sdk list` would fail if no apps are installed
- Added a --javascript option to `pb-sdk new-project` to create a template of JS code and automatically generate the appinfo.json
- Automatically detect old projects, refuse to build and offer the option to update the project
- Added `convert-project` command to update old projects to the new style (note: this will not update the source code)
- Added clean error message if a resource is missing
### iOS Application
- The developer preview iOS application will automatically offer new version of the beta firmware
- Added support for middle button in golf app
- Some iOS7 fixes
- Switched to TestFlight for distribution and crash reports
### Android Application
- The developer preview Android application will automatically offer new version of the beta firmware
- Added support for middle button in golf app
- Switched to TestFlight for distribution and crash reports
### Pebble SDK Examples
- Added an example for the persistent storage APIs
- Fixed all the iOS examples to build out of the box
- Reworked the Ocean Data Survey example | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-DP2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-DP2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 6332
} |
---
# 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.
title: Pebble SDK 2.0 DP3 - Changelog
date: 2013-10-21
---
This version brings some major improvements and a lot of bugfixes. In a nutshell, the big changes are:
* PebbleKit JavaScript now supports geolocation on all platforms
* Pebble supports the ANCS protocol. See details below.
This is a private release under NDA.
### Pebble and ANCS
Pebble has been working on integrating Bluetooth Low Energy (BLE) technology into our upcoming software releases. The initial goal for this work is to greatly enhance the notification experience between a Pebble and a BLE-capable iOS7 device (the iPhone4S and later) - this leverages the "ANCS" notification feature of iOS7. A requirement for the public release of BLE-capable Pebble SW is that it will not change the Android experience. We will work on enhancing the BLE experience specifically for Android users in future SW releases.
If you wish to help Pebble test BLE and ANCS, please read this carefully, this is pre-release software and there are still areas of the experience we are actively enhancing. We greatly appreciate your help in testing these important features :-)
Pebble SDK DP3 (and up) include BLEs capabilities. Download the firmware and mobile apps as instructed in the installation instructions. You do not need anything else.
To configure ANCS and BLE:
- If you already had email configured in the iOS Pebble app, go into the Pebble app and turn that OFF. With ANCS, email notifications will automatically mirror the notifications that show up on your phone.
- The first time you set this up (after you install BLE/ANCS firmware) you will need to pair your phone with the watch to make the BTLE connection.
- On the watch, go into the "Settings" view, and select "Bluetooth".
- On your iOS7 iPhone go into the "Settings" app, select "Bluetooth".
- You should see an entry called "Pebble-LExxxx" where xxxx is the 4 digit code that is shown at the top of the Pebble's Bluetooth screen. Select that entry, and confirm pairing.
- Ensure that BOTH traditional Bluetooth and BLE are paired. You will not be able to perform all of the functions (such as handling phone calls) if the Bluetooth-Classic connection is not working.
- We are actively working on enhancements to pairing, so this process will change as we near public release.
Known issues:
- Only pairing from iOS BT Settings works for now. In-Pebble-app pairing is still TODO.
- If you have a red bar "Notifications require additional setup" in your iOS app, this will not disappear when LE is paired / ANCS is activated. You can safely ignore it.
- Gmail/IMAP in Pebble app + ANCS = Duplicate emails. We recommend turning off email accounts from the Pebble iOS app.
- "Forget" from the watch's BT settings menu doesn't work as expected. iDevice immediately reconnects again.
- All notifications have same icon
- Max message length is shorter than Bluetooth Classic.
- Impact on battery life: we are actively characterizing and working on this, but it is currently less than Bluetooth-Classic only.
Please report any bugs by email to: [[email protected]](mailto:[email protected])!
**Remember, this release is under NDA. Please do not share word of this new feature. Thanks a lot!**
### Known problems and bugs
* Data Logging still does not work on iOS7
* On iOS, to try the "openURL()" function, you must first click the "Details Indicator" button on the table view that lists the JavaScript process
* On Android, to upgrade an existing JavaScript app, you must first kill it in the "JS App Processes" view (look for the Skull And Bones button)
* On some Android phones running 4.1, we have encountered a situation where location services were not working. This problem and the appropriate fix is described by Google [in this forum post](http://productforums.google.com/forum/#!msg/mobile/LEPcl9e3dYE/3LZEhiWACigJ).
### Pebble Firmware
- Fix a bug where Pebble would keep vibrating after answering a call
### Pebble SDK
- Fix a bug which caused all apps to share the same persistent storage file
### PebbleKit iOS/Android
- Removed some deprecated/private APIs call from PebbleKit-iOS
- Update PebbleKit-iOS project files to Xcode 5
- Fix PebbleKit Android build - moved libraries to libs/
### PebbleKit JavaScript
- Getting current location now works on iOS and Android. It is also possible to watch the current position and be notified when it changes.
- Fixed a bug on iOS where sending multiple digits number would not work
- Fixed a bug with the 2.1 release on Android where it would be impossible to use AppMessage (with PebbleKit JS)
- Receiving byte arrays now also works on iOS
- Added Pebble.getAccountToken() to get a unique token for the current user account (Note: this is not documented yet.)
### pebble tool
- Do not return 0 if something bad happened
- Display the footprint of the app in RAM and the available heap space
### Pebble iOS Application
- Fixed a UI bug on iOS7 when deleting an app
- Fixed the Developer Mode UI on iOS7
#### 2013 10 25 - 2.0-DP3.1
We have release a 3.1 update for the iOS application which should fix the most common crash for the app.
### Pebble Android application
- Fixed a bug where the Android app would continuously try to connect to the Pebble even after disconnecting/unpairing
- Fixed a bug where Facebook notifications would have duplicated content in the name field and the main field
- Automatically start an app after installation
- Fixed a bug where it would be impossible to skip the onboarding process
- Fixed a bug where switching the device orientation during firmware upgrade would cause the upgrade to start again
### Pebble SDK Examples
- Fixed a crash in dropzone
- Improved the weatherjs example to use geolocation and display the name of the city
- Added a very cool arcade game to demonstrate use of persistent storage (watchapps/pebble_arcade)
### Documentation
- Simplified installation instructions for Linux
- Fixed a lot of broken links
- Added a chapter on iOS whitelisting
- Added a chapter on fonts
- Reworked most of the developer guides | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0-DP3.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0-DP3.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 6714
} |
---
# 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.
title: Pebble SDK 2.0.0 - Changelog
date: 2014-02-03
---
This is the first public release of Pebble SDK 2.0 and Pebble firmware 2.0.
## What has changed since BETA7
Overview:
* We have fixed various crashes in the firmware (this was pre-released as 2.0-RC, 2.0-RC2 and 2.0-RC3)
* We have restored support for direct Bluetooth connection from the computer to the pebble in the `pebble` tool
* PebbleKit iOS now includes armv7s, arm64 and x86_64 libraries - There is a known bug in PebbleKit iOS 2.0.0 that can cause your application to crash when it is in the background. Please do not use this version to submit an application to Apple.
## Known bugs and issues
* DataLogging disabled
Pebble iOS 2.0.0 app can enter a crashloop situation when corrupted datalogging bytes are received from Pebble. To avoid this problem, we have disabled the datalogging APIs in firmware 2.0.0. We will re-enable datalogging when the iOS app 2.0.1 is available on the App Store.
* PebbleKit iOS 2.0.0
Can cause 3rd party applications to crash when it is in the background. Please do not use this version to submit an application to Apple. This will be fixed in 2.0.1.
### Changes for Firmware:
Changes since 2.0-RC3:
* fix a deadlock when sending datalogging information
* remove the "Your Pebble has reset" message
The changes between 2.0-BETA7 and 2.0-RC3 were:
* fixes a number of crashes
* app no longer gets killed when it cancels an invalid timer
* removes “persist_raw -9” message
* low battery message always uses the right icon
* fixes crash on watch shutdown
* fixes crash when using accel
### Changes for PebbleKit iOS:
* Updated our version of CocoaLumberJack to fix a crash that could happen when logging in the background
* Updated the build script to actually produce armv7s, arm64 and x86_64 dynamic libraries
* Improve the datalogging protocol (between PebbleApp and PebbleKit) to be more efficient
### Changes for PebbleKit Android:
No changes.
### Changes for SDK Tools:
* We have restored support for direct Bluetooth connection from the computer to the pebble in the `pebble` tool
* Better handling of timeout errors with the websockets
### Changes for Examples:
No changes.
### Changes for Documentation:
* Add parameter `did_vibrate` to AccelData and explanation.
* Add parameter `timestamp` to AccelData and explanation. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0.0.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0.0.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2957
} |
---
# 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.
title: Pebble SDK 2.0.1 - Changelog
date: 2014-02-20
---
This is a minor update to the Pebble SDK and the Pebble firmware.
## What has changed since 2.0.0
Overview:
- We have re-enabled data logging in the Pebble firmware
## Known bugs and issues
* PebbleKit iOS 2.0.0
Can cause 3rd party applications to crash when it is in the background. Please do not use this version to submit an application to Apple. This will be fixed in a later release.
## Detailed list of changes
### Changes for Firmware:
* We have re-enabled the data logging APIs.
### Changes for PebbleKit iOS:
* No changes.
### Changes for PebbleKit Android:
* No changes.
### Changes for SDK Tools:
* No changes.
### Changes for Examples:
* Reduce the accel discs step time
### Changes for Documentation:
* Updated documentation on Android intents
* Updated documentation on AppMessage, AppSync, Dictionary, Typlets | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1493
} |
---
# 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.
title: Pebble SDK 2.0.2 - Changelog
date: 2014-03-18
---
This is another minor update to the Pebble SDK and the Pebble firmware.
## What has changed since 2.0.1
Overview:
- Fixes issue that prevented some users from being able to upgrade to 2.0.
- Support for XCode 5.1
- Removed Pillow as dependency for the SDK
## Known bugs and issues
None.
## Detailed list of changes
### Changes for Firmware:
* Fix a bug that could prevent installation fo the firmware
### Changes for PebbleKit iOS:
* No changes.
### Changes for PebbleKit Android:
* No changes.
### Changes for SDK Tools:
* LibPebble upgrade to remove PIL dependency
* replaced PIL with pypng for taking screenshots
### Changes for Examples:
* Update the todolist example to use graphics_text_layout_get_content_size instead of graphics_text_layout_get_max_used_size
* Port improvements to simplicity from firmware to examples
* Update quotes app for ready event
### Changes for Documentation:
* Fixed error in API docs for accel
* Fix javascript close URL in the javascript doc | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.0.2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.0.2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1646
} |
---
# 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.
title: Pebble SDK 2.1.1 - Changelog
date: 2014-05-08
---
## What has changed since 2.1
This release fixes a bug which caused the `pebble` tool to throw an exception when a Pebble app crashed. This is the only fix and we are not releasing a firmware 2.1.1, only the SDK is updated.
## What has changed since SDK 2.0.2
Overview:
* Pebble dynamic memory allocation has been improved and will now detect when you try to free() memory twice.
* With Pebble 2.1 your application will be killed and a message is shown in the console so you can detect and fix this problem, instead of potentially causing a memory corruption issue.
* IMPORTANT: You will need to update your Pebble to run apps built with the 2.1 SDK. Applications compiled with the SDK 2.1 will not appear in the menu and will not run on Pebble firmware 2.0.
## Detailed List of Changes:
### Changes for Firmware:
* Fixed crash caused by calling number_window_set_label
* Fixed white line at the bottom of MenuLayer when last row is selected
* Fixed an issue where the watch would get into a reset loop after boot
* Fixed issue that sometimes caused persistent storage values to not persist
* Fixed issue where caller ID shows info from the previous call
* Fixed caller ID sometimes not displaying on outgoing calls
* Pebble dynamic memory allocation has been improved. Your application will now be killed when you try to free() memory twice
* Apps can no longer crash the watch on app exit
* Bluetooth reconnection is more reliable
* Battery monitor is more consistent
* Multiple power reduction improvements
* Documentation improvements
* Clip text instead of truncating when vertical space is inadequate
* Notifications can be cleared via the Notification section in the Settings menu
### Changes for PebbleKit iOS:
* Some improvements to datalogging to help troubleshoot issues
### Changes for PebbleKit Android:
* No changes
### Changes for SDK Tools:
* Allow firmware bundles to be installed with the install command
* Allow SDK location to be overridden by the `PEBBLE_SDK_PATH` environment variable
* Replaced PIL with pypng for taking screenshots
* Fixed extra row always being added to screenshots
### Changes for Examples:
* Removed ToDoList demo from SDK examples
### Changes for Documentation:
* Various documentation fixes and improvements | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.1.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.1.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2933
} |
---
# 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.
title: Pebble SDK 2.1 - Changelog
date: 2014-05-06
---
## What has changed since SDK 2.0.2
Overview:
* Pebble dynamic memory allocation has been improved and will now detect when you try to free() memory twice.
* With Pebble 2.1 your application will be killed and a message is shown in the console so you can detect and fix this problem, instead of potentially causing a memory corruption issue.
* IMPORTANT: You will need to update your Pebble to run apps built with the 2.1 SDK. Applications compiled with the SDK 2.1 will not appear in the menu and will not run on Pebble firmware 2.0.
## Detailed List of Changes:
### Changes for Firmware:
* Fixed crash caused by calling number_window_set_label
* Fixed white line at the bottom of MenuLayer when last row is selected
* Fixed an issue where the watch would get into a reset loop after boot
* Fixed issue that sometimes caused persistent storage values to not persist
* Fixed issue where caller ID shows info from the previous call
* Fixed caller ID sometimes not displaying on outgoing calls
* Pebble dynamic memory allocation has been improved. Your application will now be killed when you try to free() memory twice
* Apps can no longer crash the watch on app exit
* Bluetooth reconnection is more reliable
* Battery monitor is more consistent
* Multiple power reduction improvements
* Documentation improvements
* Clip text instead of truncating when vertical space is inadequate
* Notifications can be cleared via the Notification section in the Settings menu
### Changes for PebbleKit iOS:
* Some improvements to datalogging to help troubleshoot issues
### Changes for PebbleKit Android:
* No changes
### Changes for SDK Tools:
* Allow firmware bundles to be installed with the install command
* Allow SDK location to be overridden by the `PEBBLE_SDK_PATH` environment variable
* Replaced PIL with pypng for taking screenshots
* Fixed extra row always being added to screenshots
### Changes for Examples:
* Removed ToDoList demo from SDK examples
### Changes for Documentation:
* Various documentation fixes and improvements | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2705
} |
---
# 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.
title: Pebble SDK 2.2 - Changelog
date: 2014-06-04
---
## Detailed List of Changes:
### Changes for Firmware:
* Music app redesign to fix some layout issues & add progress bar
* Fix persist reads returning too little data if previously partially read
* Additional stability improvements
* Alarm now vibrates for 10 min instead of 1 min
* Launcher menu is now re-orderable. Hold the select button to enter reorder mode
* Volume control in the music app. Hold the select button in the music app to enter volume control mode
### Changes for PebbleKit iOS:
* Removed PBWatch+PhoneVersion (moved to PebblePrivateKit)
* Make PBWatch+Version report the correct version
* Fixed a crash when calling PBNumber description
### Changes for PebbleKit Android:
No changes
### Changes for SDK Tools:
No changes
### Changes for Examples:
No changes
### Changes for Documentation:
No changes | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1465
} |
---
# 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.
title: Pebble SDK 2.3 - Changelog
date: 2014-06-30
---
## Detailed List of Changes:
### Changes for Firmware:
* Don't generate multiple single click events on release if a repeating click handler is also used
* Fixed a small memory leak when destroying number_layer objects
* Fixed a menu_layer display bug when header height is set to 0
* Allow app developers to supply their own ldscript
* Give a better error message when an unsupported libc function is used
* *_destroy functions now correctly do nothing when called with NULL pointers
* Fixed some BT LE connectivity issues
* Fixed a crash when we ran out of persist space
* Fixed a crash on reconnect when a user had a lot of pending iOS notifications
* Fixed an issue where the watch would continue to vibrate after a call is ended
* Fixed a display issue in Bluetooth settings when the status bar incorrectly says "Now Discoverable" in airplane mode
* Fixed a display issue with the notification font settings
* Fixed a display issue with the music app showing stale information when bluetooth is disconnected.
* Added the ability to skip to the next and previous notification by double clicking the up and down buttons
* Disabled the use of the back button for the Bluetooth pairing screen and the Alarm screen
* Show a status bar icon when notifications are set to "Phone Calls Only"
### Changes for PebbleKit iOS:
* Removed Bluetooth LE code from PebbleKit
* Improvements to data logging to help troubleshoot issues
* Removed PBWatch+PhoneVersion and +Polling
* Made PBWatch+Version report the correct version
* Fixed a crash when calling PBNumber description
* Changed imports from \<PebbleKit/HeaderName.h\> to "HeaderName.h" format
* Fixed on rare race-condition when sending data between phone and watch
* Made PebbleKit.podspec pass most-recent CocoaPod linter
* Prefixed internally used logging classes to fix conflict when using CocoaLumberjack in your app
* Made existing logging more descriptive
### Changes for PebbleKit Android:
No changes
### Changes for SDK Tools:
No changes
### Changes for Examples:
No changes
### Changes for Documentation:
* Added documentation for the calloc libc function
* Documented that text drawing functions use UTF-8 and will return errors on invalid input | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.3.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.3.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2850
} |
---
# 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.
title: Pebble SDK 2.4.1 - Changelog
date: 2014-08-12
---
## Detailed List of Changes:
### Changes for Firmware:
* Fix a compilation problem that caused firmware 2.4 to reduce the amount of memory available to apps
### Changes for PebbleKit iOS:
No changes
### Changes for PebbleKit Android:
No changes
### Changes for SDK Tools:
No changes
### Changes for Examples:
No changes
### Changes for Documentation:
No changes | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.4.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.4.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1009
} |
---
# 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.
title: Pebble SDK 2.4 - Changelog
date: 2014-08-11
---
## Detailed List of Changes:
### Changes for Firmware:
* Fix a potential crash when using scroll layers or animations
* Added support for realloc
* Added a gbitmap_create\_blank function to create empty bitmaps of a fixed size
* Added number_window\_get_window()
* Fixed a crash with atan2_lookup when high input values were used
* Fixed a bug where TupletInteger could not be used with unsigned integers
* Fixed several bluetooth reliability issues
* Fixed a case where the "Setup notifications" banner would erroneously show in the iOS Pebble app
* Fixed a bug with the music app where media playing faster than real time could not be paused
* Fixed a bug where the notifications view could show a rapidly increasing counter for number of notifications when first displayed
* Fixed a bug where switching watchfaces could cause the same watchface to be relaunched
### Changes for PebbleKit iOS:
No changes
### Changes for PebbleKit Android:
No changes
### Changes for SDK Tools:
No changes
### Changes for Examples:
No changes
### Changes for Documentation:
* Improved documentation around click handling | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.4.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.4.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1751
} |
---
# 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.
title: Pebble SDK 2.5 - Changelog
date: 2014-09-18
---
>If you are upgrading from a previous version of the SDK, you will need to run the `pebble clean` command before using the SDK 2.5 with your project.
##Major Changes
* FW 2.5 includes an optimized version of ``snprintf`` (and related functions like ``APP_LOG``, etc) that does not support some length format specifiers previously supported (%hh, %ll, %j, %z, %t). The list of supported specifiers has been updated in the ``snprintf`` documentation. For those of you that use these previously-supported specifiers, please do not hesitate to [contact us](/contact) and we'd be happy to assist you with updating your code.
* Added [compass](/guides/events-and-services/compass) support.
* Enforced versionLabel formatting in appinfo.json in preparation for app auto updates.
* Added support for Pebble app relaunch on iOS when a Pebble watch is in proximity.
* Added notification dismissal support on iOS8.
* Added emoji support to Pebble notifications and system fonts.
## Detailed List of Changes:
### Changes for Firmware:
* Added functions ``heap_bytes_free`` and ``heap_bytes_used`` to view current heap memory usage.
* Added support for ``uuid_equal`` and ``uuid_to_string``.
* Added function ``accel_raw_data_service_subscribe`` to get accelerometer data with a single timestamp for all samples (significantly reduces memory usage for apps that do not depend on timestamps).
* Added [compass](/guides/events-and-services/compass) support.
* Added emoji support to Pebble notifications and system fonts `GOTHIC_24_BOLD`, `GOTHIC_18` and `GOTHIC_18_BOLD`.
* Fixed a bug that would cause a crash if a screen shot was taken while one was already in progress.
* Fixed an issue where Pebble APIs would use non-reentrant versions of standard C functions causing unexpected changes to return values.
* Fixed a bug with accel_service that could result in memory being freed twice.
* Fixed a bug where Golf API would show stale information on disconnect.
* Fixed a bug that prevented calling ``menu_layer_set_selected_index`` before ``menu_layer_set_callbacks``.
* Fixed a bug which would sometimes cause the command line logging tool to crash when a watchapp crashed.
* Fixed a bug that would cause the sample rate of the accelerometer to be reset when subscribing.
* Added support for Pebble app relaunch on iOS when a Pebble watch is in proximity.
* Added support for notification dismissal on iOS8.
* Fixed numerous bluetooth reliability & connection issues.
* Fixed a reset and other various bugs related to Data Logging.
* Fixed a bug that allowed backing out of FW update screen.
* Fixed a bug that would cause animations between windows to be slow.
* Fixed a bug where the Date UI would allow selection of invalid dates.
* Fixed a bug which would prevent the down button from scrolling through notification history.
* Fixed a bug with AVRCP that could lead to a crash.
* Set backlight to stay on during alarm ringing.
* Changed the default backlight setting to AUTO.
* Fixed a bug which would allow developers to ask for more than 25 accel samples per update.
* Added check for NULL parameter in ``gpath_draw_filled``.
### Changes for PebbleKit iOS:
PebbleKit iOS has been removed from the SDK download. Please find the latest PebbleKit iOS on [GitHub](https://github.com/pebble/pebble-ios-sdk) or on [CocoaPods](http://cocoapods.org/) under 'PebbleKit'.
### Changes for PebbleKit Android:
PebbleKit Android has been removed from the SDK download. Please find the latest PebbleKit Android on [GitHub](https://github.com/pebble/pebble-android-sdk).
### Changes for SDK Tools:
* Enforced versionLabel formatting in appinfo.json in preparation for app auto updates.
### Changes for Examples:
* Added [compass example]({{site.links.examples_org}}/feature-compass) application.
### Changes for Documentation:
* Added ``CompassService`` API document.
* Added missing ``calloc`` and ``realloc`` documentation.
* Improved ``tick_timer_service_subscribe`` documentation.
* Added missing ``RotBitmapLayer`` documentation.
* Corrected ``window_single_click_subscribe`` API entry.
* Corrected time_t time() function to specify that epoch adjusts for timezone and DST.
* Fixed typo in the ``AppMessage`` documentation.
* Improved ``gbitmap_create_with_data`` documentation.
* Fixed typo in documentation for ``resource_get_handle``. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.5.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.5.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 4968
} |
---
# 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.
title: Pebble SDK 2.6.1 - Changelog
date: 2014-10-01
---
> This release is a hotfix for the SDK 2.6 release
### Changes for SDK Tools:
* Fix bug preventing use of `pebble analyze-size`
* Fix bug that caused compile errors with the use of custom fonts
---
### Pebble SDK 2.6 Release Summary ([full changelog](/sdk/changelogs/2.6/))
##### Major Changes:
* Add support for [background apps](/guides/events-and-services/background-worker) with ``AppWorker``
* Add ``graphics_capture_frame_buffer``, ``graphics_release_frame_buffer``, ``graphics_frame_buffer_is_captured`` APIs to expose framebuffer
* Add ``WatchInfo`` APIs to expose watch color, watch model, and firmware version
* Add quick launch support
* Bring back select-button-to-dismiss-notification on Android & iOS < 8
* Add --worker option to `pebble new-project` to create file structure for apps with background workers
* Add background worker [example]({{site.links.examples_org}}/feature-background-counter) | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.6.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.6.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1552
} |
---
# 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.
title: Pebble SDK 2.6 - Changelog
date: 2014-09-30
---
> The symbols for `NUM_ANIMATION_CURVE` and `AnimationTimingFunction` have been removed in SDK 2.6. They were exposed in pebble.h in a previous release, but were not documented and are not used for ``Animation`` or ``PropertyAnimation`` APIs.
## Detailed List of Changes:
### Changes for Firmware:
* Add support for [background apps](/guides/events-and-services/background-worker/) with ``AppWorker``
> NOTE: The Background Worker API is not intended to be used as a wakeup mechanism for timer-based events or activities. SDK 2.7 will include a new Wakeup API that will allow you to set a timer that automatically launches your app in the foreground. Please do not use the Background Worker API to set such wakeups.
* Improve bluetooth connection service by only reporting disconnections of a certain length in time
* Add ``graphics_capture_frame_buffer``, ``graphics_release_frame_buffer``, ``graphics_frame_buffer_is_captured`` APIs to expose framebuffer
* Add ``WatchInfo`` APIs to expose watch color, watch model, and firmware version
* Fix bug where reading an existing key from persistent storage would fail
* Fixed Sports API bug causing menu item to not always appear in app launcher
* Fix bug with PebbleKit iOS and AppMessage timeouts
* Add quick launch support
* Bring back select-button-to-dismiss-notification on Android & iOS < 8
* Re-enable vibration when done charging
* Improve battery life
### Changes for SDK Tools:
* Add a --generate command line option to the coredump command
* Add --worker option to `pebble new-project` to create file structure for apps with background workers
### Changes for Examples:
* Add background worker [example]({{site.links.examples_org}}/feature-background-counter)
### Changes for Documentation:
* Add [AppWorker Guide](/guides/events-and-services/background-worker/)
* Add documentation for ``Worker``, ``AppWorker``, ``WatchInfo`` | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.6.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.6.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2524
} |
---
# 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.
title: Pebble SDK 2.7 - Changelog
date: 2014-10-16
---
## Detailed List of Changes:
### Changes for Firmware:
* Add ``Wakeup`` API
* Add ``launch_reason`` API
* Fix a bug that caused ``watch_info_get_color`` to crash the app when used
* Add ``clock_to_timestamp`` API
* Add ``clock_is_timezone_set`` API. In firmware 2.7, this function will always return false
as timezone support is not yet implemented
* Improve Bluetooth reliability
* Fix bug showing 0% battery warning
### Changes for SDK Tools:
No changes
### Changes for Examples:
* Add [wakeup example]({{site.links.examples_org}}/feature-app-wakeup)
### Changes for Documentation:
* Add ``Wakeup`` API documentation
* Fix bug with missing ``snprintf`` specifier documentation | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.7.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.7.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1318
} |
---
# 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.
title: Pebble SDK 2.8.1 - Changelog
date: 2014-12-09
---
This release fixes a number of bugs and improves BLE pairing on iOS.
See [FW 2.8 Changelog](/sdk/changelogs/2.8/) for new features and major fixes.
## Detailed List of Changes:
### Changes for Firmware:
* Fix bug that would cause the watch to crash when ``accel_data_service_unsubscribe`` was called in a `window_unload` handler
* Revert error return values from ``resource_load_byte_range`` to pre-2.8 behavior
* Speed up BLE pairing on iOS
* Fix a bug that would cause an app to be built incorrectly if the first resource in appinfo.json was declared twice.
* Reduce stack usage of resource handling to prevent stack overflows introduced in 2.8
* Fix several strings in non-English languages
* Fix bug in ``AppMessage`` that would cause the watch to crash
### Changes for SDK Tools:
* Fix an issue where the SDK failed to build apps with non-ascii characters in the name.
* Include locale.h in pebble.h
### Changes for Examples:
No changes
### Changes for Documentation:
No changes | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.8.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.8.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1626
} |
---
# 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.
title: Pebble SDK 2.8 - Changelog
date: 2014-11-20
---
This release changes the rendering behaviour of custom fonts in apps compiled with SDK 2.8. The change
improves the visual appearance of fonts, but also causes them to be slightly larger. If you rebuild with
SDK 2.8 and text no longer fits, you can revert to the old behaviour by setting `"compatibility": "2.7"`
in the resource block for that font, like so:
```javascript
{
"type": "font",
"file": "fonts/something.ttf",
"name": "FONT_SOMETHING_24",
"compatibility": "2.7"
}
```
System fonts are unaffected by this change.
## Detailed List of Changes:
### Changes for Firmware:
* All system `GOTHIC` fonts are expanded to contain 351 characters
* Add ``setlocale`` and ``i18n_get_system_locale`` APIs in preparation for internationalization support
* Fix an issue that could cause an incorrect accelerometer sampling rate to be used
* Fix an issue causing wakeup events scheduled less than thirty seconds in the future to fail
* Improve the performance of very small resource reads
* Fix an issue where iOS calendar alert notifications sometimes did not appear
* Fix an issue sometimes causing spurious "Loading..." notifications to appear on iOS
* Improve behaviour when trying to boot with a critically low battery
### Changes for SDK Tools:
* Improve font rendering for custom fonts when compiling with SDK 2.8
* This can change the font metrics. If the font no longer fits, add the flag `"compatibility": "2.7"`
to the resource entry for that font.
### Changes for Examples:
No changes
### Changes for Documentation:
* Fix explanation of the timezone of timestamps passed to ``wakeup_schedule`` | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.8.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.8.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2255
} |
---
# 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.
title: Pebble SDK 2.9 - Changelog
date: 2015-02-10
---
This release introduces actionable notifications for Android and minor stability improvements.
## Detailed List of Changes:
### Changes for Firmware:
* Add support for [Android actionable notifications](/blog/2014/12/19/Leverage-Android-Actionable-Notifications/)
* Fix bug that caused crashes when ``mktime()`` was used
* Fix behavior of ``window_stack_pop_all`` so that only the last window is animated
* Compiler will now show an error when the resources limit is reached
* Improve the stability of ``Worker``on launch
* Fix bug where a ``Worker`` selected from the Activity menus would not be set to default
* Fix bug where a ``Worker`` launched by a new app would not be set to default after the default worker was deleted
* Fix an issue that caused ``AppMessage`` to report sends as failed when sending/recieving a high volume of messages
* Notification date format is standardized: "Wednesday 11, February" -> "Wednesday, February 11"
### Changes for SDK Tools:
No changes
### Changes for Examples:
* Update openweather apis used in example apps.
### Changes for Documentation:
No changes | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/2.9.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/2.9.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1737
} |
---
# 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.
title: Pebble SDK 3.0-beta10 - Changelog
date: 2015-04-30
---
This is the first beta release of Pebble SDK 3.0.
All applications compiled with previous SDK should work on 3.0 and up.
However, we have made several changes to the APIs in this release that will
require source code changes.
We **strongly recommend** that all developers rebuild and retest their apps with
this version of the SDK.
*All apps built with beta10 will build with future releases of the SDK.*
## Detailed List of Changes:
### Changes for Firmware:
* The PDC format has changed. PDCs created for developer preview 9 or earlier will
no longer work.
### Changes to SDK:
* Add new ``StatusBarLayer`` that you should use in apps that you want to have
a status bar. We've added a
[section to the 3.0 migration guide](/sdk/migration/migration-guide-3/)
with example code and screenshots.
* Added `PBL_SDK_2` and `PBL_SDK_3` or detecting the major version of the SDK at
compile time.
* Added new `buffer_size` parameter to ``clock_get_timezone``.
* Added Pebble Time Steel models to ``WatchInfoModel``.
### Changes for SDK Tools:
* The emulator now works on 32 bit Linux machines.
* The timeline now works with Python 2.7.9.
### Changes to Timeline:
* Apps in sandbox mode no longer have a whitelist by default. Existing timeline
apps are not affected. Take a look at the
[Enabling the Timeline](/guides/pebble-timeline/) guide for further
information.
* There are more new icons you can use in your pins. Check out the
[guide on pin structure](/guides/pebble-timeline/pin-structure)
for more details.
### Changes for Examples:
*No changes*
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-beta10.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-beta10.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2267
} |
---
# 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.
title: Pebble SDK 3.0-beta11 - Changelog
date: 2015-05-10
---
This is the second beta release of Pebble SDK 3.0. It includes a number of fixes to improve stability as well as new guide for Design and Interaction.
## Detailed List of Changes:
### Changes for Firmware:
* Crashes within ``worker`` will now show up with a crash dialog on the watch.
* Fixed bug where ``Timeline`` events displayed improper start/finish times.
* Fixed bug where images were drawn incorrectly if bounds in ``layer_set_bounds`` were set differently than (0, 0, size.w, size.h).
### Changes to SDK:
* Fixed a bug where apps would fail to wake up because ``Wakeup`` expected time in UTC.
### Changes for SDK Tools:
*No changes*
### Changes to Timeline:
*No changes*
### Changes for Examples:
*No changes*
### Changes for Documentation:
* Added [Design and Interaction](/guides/design-and-interaction/) guides. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-beta11.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-beta11.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1480
} |
---
# 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.
title: Pebble SDK 3.0-beta12 - Changelog
date: 2015-05-17
---
This SDK release includes improvements to stability including fixes for timeline and timezone. There's also a new guide for making your apps compatible on both platforms.
## Detailed List of Changes:
### Changes for Firmware:
* Fixed a bug with timezone that would result in reporting the incorrect time.
* Ongoing timeline events that started less than 10 minutes ago now show up in the future.
### Changes to SDK:
* Fixed ``Pebble.getAccountToken`` on Android to return the same token as iOS.
To learn how to convert a new token to an old one for the same account, read
the
[Migration Guide](/sdk/migration/migration-guide-3#pebblekit-js-account-token).
### Changes for SDK Tools:
* Fixed a bug with the `pebble analyze-size` command caused by an incorrect elf file location.
### Changes to Timeline:
* Fixed a bug where [Reminders](/guides/pebble-timeline/pin-structure/) would not be shown at the precise time they were set.
### Changes for Examples:
* Updated the layout and content of the [Examples](/examples/) page.
### Changes for Documentation:
* Added a new guide, [Building For Every Pebble](/guides/best-practices/building-for-every-pebble); this covers the best practices for building an app compatible with both platforms. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-beta12.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-beta12.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1902
} |
---
# 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.
title: Pebble SDK 3.0-dp1 - Changelog
date: 2015-02-26
---
This is the first Developer Preview release of the brand new Pebble SDK 3.0.
We will not be providing a comprehensive changelog for this release, but you
can take a look at our guide to [What's New in SDK 3.0](/sdk/whats-new/) and
our [3.0 migration guide](/sdk/migration-guide/). | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 920
} |
---
# 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.
title: Pebble SDK 3.0-dp2 - Changelog
date: 2015-03-05
---
This is the second Developer Preview release of Pebble SDK 3.0.
We have updated the Aplite SDK to include some macros that make developing apps
for both platforms easier. For example, you can now use `GColorEq` on both
Aplite and Basalt and the SDK will take care of the platform differences.
## Detailed List of Changes:
### Changes for Firmware:
Multiple stability improvements.
### Changes for SDK Tools:
* Running the Pebble emulator on Mac OS X will no longer use up 100% CPU.
* Apps built with 3.0-dp2 will install correctly on iOS
* Fixed `png2pblpng` for case of 1 color causing bitdepth of 0.
### Changes for Examples:
*No changes*
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1334
} |
---
# 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.
title: Pebble SDK 3.0-dp3 - Changelog
date: 2015-03-13
---
This is the third Developer Preview release of Pebble SDK 3.0.
We have slightly modified the build process in this release to separate out
logs from Aplite and Basalt when building your app.
In order to take advantage of this change, you will need to update your wscript.
The easiest way to do is to create a new project and copy the wscript.
## Detailed List of Changes:
### Changes for Firmware:
* Multiple stability improvements.
### Changes for SDK Tools:
* Separated Aplite, Basalt and bundling log output when building an app.
* Added new [`hiddenApp`](/guides/tools-and-resources/app-metadata/)
property to appinfo.json.
### Changes for Examples:
Updated examples with new wscript.
### Changes for Documentation:
* Multiple improvements to various 3.0 documentation, including fixing broken
links and undocumented function parameters. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp3.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp3.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1495
} |
---
# 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.
title: Pebble SDK 3.0-dp4 - Changelog
date: 2015-03-19
---
This is the fourth Developer Preview release of Pebble SDK 3.0.
## Detailed List of Changes:
### Changes for Firmware:
* Added basic timeline interface for testing and development purposes.
**This is not the finished timeline UI**.
* Pressing the up/down button from the main emulator screen will now open the
timeline.
* Made the generic, sports, weather and calendar layout available to timeline
pins (see the [timeline guides](/guides/pebble-timeline/) for more information).
### Changes to SDK:
* Fixed ``property_animation_clone()`` compatibility macro (for Aplite binaries).
* Added ``launch_get_args()`` for getting the `launchCode` attribute from an
[`openWatchApp`](/guides/timeline/pin-structure/#pin-actions) timeline pin
action.
### Changes for SDK Tools:
* Emulator now has the proper timezone set automatically (in firmware and in
JavaScript).
* Added the `insert-pin` and `delete-pin` commands to the emulator to interact
with the timeline locally.
* Added the `pebble login` command to connect your emulator to your Pebble
account. *This is required for the timeline to work*.
* Fix a bug where the build would fail if the project contains a space in
the name.
* The [`targetPlatforms` attribute is now supported on resources](/guides/app-resources/platform-specific/).
You can use it to specify that a resource should only be available on one platform.
#### Known Issues
The timeline will not work if you have Python 2.7.8+. Please use Python 2.7.6 if
you want to work with the new timeline APIs.
### Changes for Examples:
Examples have been removed from the SDK download, and our old examples
repository has been deprecated.
You can now find all our examples on
[pebble-examples on GitHub]({{site.links.examples_org}}/).
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp4.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp4.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2460
} |
---
# 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.
title: Pebble SDK 3.0-dp5 - Changelog
date: 2015-03-27
---
This is the fifth Developer Preview release of Pebble SDK 3.0.
The biggest new features with this release are
[antialiasing and stroke width](/guides/graphics-and-animations/drawing-primitives-images-and-text/).
## Detailed List of Changes:
### Changes for Firmware:
* Antialiasing is enabled by default for all apps built with SDK 3.0 or higher.
### Changes to SDK:
* Added ``graphics_context_set_antialiased`` to toggle adding antialiasing to
the graphics_draw_* functions. See our
[Drawing Graphics](/guides/graphics-and-animations/drawing-primitives-images-and-text/)
guide for more details.
* Added ``graphics_context_set_stroke_width`` to set the stroke width for
drawing routines. See our
[Drawing Graphics](/guides/graphics-and-animations/drawing-primitives-images-and-text/)
guide for more details.
### Changes for SDK Tools:
* Fixed bug where projects with png-trans resources would cause build failures.
### Changes for Examples:
* Added [ks-clock-face]({{site.links.examples_org}}/ks-clock-face)
example to demonstrate the new antialiasing and stroke width APIs.
### Changes for Documentation:
* Documented the [new pebble commands](/guides/tools-and-resources/pebble-tool/)
for working with the emulator, and improved the rest of the tool documentation. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp5.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp5.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1940
} |
---
# 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.
title: Pebble SDK 3.0-dp6 - Changelog
date: 2015-04-03
---
This is the sixth Developer Preview release of Pebble SDK 3.0.
## Detailed List of Changes:
### Changes for Firmware:
* The action bar has been updated for 3.0. It is now 30px wide and has new
animations when the buttons are selected.
* The antialiasing added in 3.0-dp5 has been improved.
### Changes to SDK:
* ``ActionBarLayer`` uses the new 3.0 action bar, which provides one new API
function: ``action_bar_layer_set_icon_animated``.
### Changes for SDK Tools:
*No changes*
### Changes to Timeline:
* `createMessage` and `updateMessage` have been renamed to `createNotification`
and `updateNotification`.
The [Node.js pebble-api][pebble-api-node] client has been updated to match.
### Changes for Examples:
*No changes*
### Changes for Documentation:
*No changes*
[pebble-api-node]: https://www.npmjs.org/package/pebble-api | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp6.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp6.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1489
} |
---
# 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.
title: Pebble SDK 3.0-dp7 - Changelog
date: 2015-04-09
---
This is the seventh Developer Preview release of Pebble SDK 3.0.
## Detailed List of Changes:
### Changes for Firmware:
*No changes*
### Changes to SDK:
* Added ``graphics_draw_rotated_bitmap`` for drawing rotated bitmaps to a
GContext.
* Added new ``Draw Commands`` which allow for doing vector-like graphics and
even animating them.
* Added ``action_bar_layer_set_icon_press_animation`` for setting the direction
of the animation when selecting actions in the ``ActionBarLayer``.
* Updated ``MenuLayer`` with new methods and callbacks to support color
highlighting.
### Changes for SDK Tools:
* You are no longer required to log in to the Pebble tool. If you want to use
the Pebble timeline in the emulator you will still need to log in.
### Changes to Timeline:
* Added `foregroundColor`, `backgroundColor`, `headings`, and `paragraphs` as
new fields on the Layout object for Pins. Check out the
[Pin Structure guide](/guides/pebble-timeline/pin-structure/) for more
details.
### Changes for Examples:
* Created [cards-example]({{site.links.examples_org}}/cards-example) to
demonstrate the new [Pebble Draw Commands](``Draw Commands``).
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp7.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp7.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1854
} |
---
# 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.
title: Pebble SDK 3.0-dp8 - Changelog
date: 2015-04-16
---
This is the eighth Developer Preview release of Pebble SDK 3.0. This week we
were focussed on the firmware UI and so this release does not contain many
changes that are visible to developers.
## Detailed List of Changes:
### Changes for Firmware:
* Updated the timeline UI.
* In preparation for the new 3.0 design style, we have removed the old system status bar and all 3.0 apps are now fullscreen by default. We will be releasing a new StatusLayer in the future.
### Changes to SDK:
* Added [`Pebble.getActiveWatchInfo()`](/guides/communication/using-pebblekit-js) for getting details about the currently connected Pebble watch.
### Changes for SDK Tools:
* Fixed incorrect values when reporting the maximum sizes of apps.
* Added SDK emulator support to the
[pebble command line tools](/guides/publishing-tools/pebble-tool) for
`emu_tap`, `emu_bt_connection`, `emu_compass`, `emu_battery` and `emu_accel`.
* Fixed the issues with installing apps to the emulator.
### Changes to Timeline:
*No changes*
### Changes for Examples:
*No changes*
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp8.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp8.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1743
} |
---
# 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.
title: Pebble SDK 3.0-dp9 - Changelog
date: 2015-04-27
---
This is the ninth Developer Preview release of Pebble SDK 3.0.
## Detailed List of Changes:
### Changes for Firmware:
*No changes*
### Changes to SDK:
* Added ``menu_layer_set_normal_colors`` and ``menu_layer_set_highlight_colors``
to make using ``MenuLayer``s much simpler.
* Renamed `GColorEq` to ``gcolor_equal`` to be more consistent with similar
methods.
* `InverterLayer` has been
[deprecated](/guides/migration/migration-guide-3/) and removed from the
SDK.
### Changes for SDK Tools:
* The pebble tool will now use any running emulator before attempting to launch
the default Basalt emulator
* Fixed a bug causing an incorrect color for foregroundColor and backgroundColor
on timeline pins
### Changes to Timeline:
* There are now many more icons you can use in your timeline pins. Check out
the [guide on pin structure](/guides/timeline/pin-structure/#pin-icons)
for more details. **Note:** All the existing icons have been renamed.
### Changes for Examples:
* Deprecated feature-inverter-layer SDK example (see deprecation notice on
[GitHub]({{site.links.examples_org}}/feature-inverter-layer))
### Changes for Documentation:
*No changes* | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0-dp9.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0-dp9.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1822
} |
---
# 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.
title: Pebble SDK 3.0 - Changelog
date: 2015-05-27
---
This is the first public release of SDK 3.0. It includes a number of small fixes to polish the timeline ui as well as improve stability.
## Detailed List of Changes:
### Changes for Firmware:
* Added a crash dialogue when watchfaces crash.
### Changes to SDK:
*No changes*
### Changes for SDK Tools:
- The emulator now supports WebSockets
- The emulator now persists JavaScript `localStorage` between emulator launches
- The emulator now caches app JavaScript between emulator launches
- The SDK no longer depends on cython to install correctly.
### Changes to Timeline:
* Fixed a bug where text would overlay in calendar reminders.
### Changes for Examples:
*No changes*
### Changes for Documentation:
* Fixed documentation for ``clock_to_timestamp`` to specify that it returns a timestamp in localtime on aplite. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.0.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.0.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1464
} |
---
# 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.
title: Pebble SDK 3.1 - Changelog
date: 2015-06-30
---
### Changes to Firmware
* Fix watch reset on calling ``compass_service_subscribe`` from a worker.
* Fix bug where setting click config is ignored if a notification is displayed.
* Fix app crash on calling ``gdraw_command_sequence_destroy``.
* Fix bug causing valid PNG8 images with a zero-length `tRNS` chunk to not load.
* Fix app crashes on 2.x apps using MenuLayers.
* Fix app crashes on 2.x apps using ScrollLayer.
* Fix ActionBarLayer being drawn as white when set to GColorClear.
* Fix bug causing ``menu_cell_title_draw`` and ``menu_cell_basic_header_draw`` to always render text in black.
* Fix alarms sometimes crashing the watch after vibrating for ten minutes.
* Fix transparent zero-radius circles rendering incorrectly.
* Improve rendering of zero-length lines with stroke width greater than one.
* Correctly display a sloth after deleting all pins on the timeline.
* Improve Bluetooth reliability.
* Reduced applog output from the launcher menu.
* Fix multiple cells being highlighted when setting the Do Not Disturb time range.
* Improve responsiveness when returning to a watchface from the launcher.
### Changes to SDK
* `window_set_status_bar_icon` is now deprecated.
### Changes to Emulator/Phonesim
* Fix WebSocket connections staying open after closing the app.
* Improve reliability of Aplite emulator installs when there are many timeline pins
* XMLHttpRequest now correctly returns a Uint8Array instead of ArrayBuffer.
### Changes to Pebble Tool
* Add support for `pebble app-config` command.
* Modify `pebble rm` command to use --bank or --uuid on 2.x, and --uuid on 3.x
* Modify `pebble current`, `pebble list` and `pebble uuids` commands to return a no-op message on 3.x.
* Remove login warning when not using emulator/phonesim.
* Improve error logging for JSON parsing errors.
* Fix a minor analytics bug.
* Fix requirements.txt bug.
### Changes to Documentation
* Update documentation for `window_set_fullscreen`.
* Update documentation for ``clock_to_timestamp``.
* Fix typo in documentation for ``MenuLayerDrawBackgroundCallback``. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2707
} |
---
# 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.
title: Pebble SDK 3.10-beta1 - Changelog
date: 2016-02-15
---
This is a pre-release SDK, containing a preview of the new Pebble Health
API.
### Changes to Firmware
* Added energy (Calorie) usage to the Health app.
* Changed "till" to "'til" in the low battery modals.
* Improved firmware stability.
### Changes to SDK
* Added ``health_service_get_measurement_system_for_display`` to retrieve the user's unit preference.
* Added ``health_service_sum_averaged`` and ``health_service_metric_averaged_accessible`` to access
average health data. These can be used to determine the goal line used by the Pebble Health app.
* Added ``HealthMetricRestingKCalories`` and ``HealthMetricActiveKCalories`` to retrieve Calorie burn
information from Pebble Health. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.10-beta1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.10-beta1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1338
} |
---
# 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.
title: Pebble SDK 3.10-beta2 - Changelog
date: 2016-02-19
---
This is a pre-release SDK, containing a preview of the new Pebble Health
API.
The following release notes list only changes since [3.10-beta1](/sdk/changelogs/3.10-beta1/).
### Changes to Firmware
* ``health_service_get_measurement_system_for_display`` no longer crashes when called on
real watches.
* ``rand`` is now seeded from the hardware RNG on app start, as it was in firmware 3.4 and
earlier.
* An issue causing the sleep graph to sometimes be blank on the deep sleep display of the
Health app was resolved.
### Changes to SDK
* `CFLAGS` and `LINKFLAGS` env variables are now correctly honored by the app build process.
* JSON files under the `src/js/` directory are available to `require` in newly-created projects.
* ``persist_write_bool`` and ``persist_write_int`` are now correctly documented to return the
number of bytes written on success. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.10-beta2.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.10-beta2.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1509
} |
---
# 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.
title: Pebble SDK 3.10-beta6 - Changelog
date: 2016-03-04
---
This is a pre-release SDK, containing a preview of the new Pebble Health
API.
The following release notes list only changes since [3.10-beta2](/sdk/changelogs/3.10-beta2/).
### Changes to Firmware
* Improved Health accuracy.
* Improved firmware stability.
### Changes to SDK
* Added information necessary to debug workers as well as apps.
* Added information about SDK calls to gdb. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.10-beta6.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.10-beta6.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1029
} |
---
# 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.
title: Pebble SDK 3.10.1 - Changelog
date: 2016-03-10
---
This is a hotfix for [SDK 3.10](/sdk/changelogs/3.10/).
### Changes to Firmware
* Restored the following emoji that were inadvertently removed:
* U+2192 RIGHTWARDS ARROW: →
* U+25BA BLACK RIGHT-POINTING POINTER: ►
* U+2605 BLACK STAR: ★
* U+1F3A4 MICROPHONE: 🎤
* U+1F3A5 MOVIE CAMERA: 🎥
* U+1F435 MONKEY FACE: 🐵
* U+1F4AA FLEXED BICEPS: 💪
* U+1F4F7 CAMERA: 📷
* U+1F648 SEE-NO-EVIL MONKEY: 🙈
* U+1F3B5 MUSICAL NOTE: 🎵
* U+1F381 WRAPPED PRESENT: 🎁
* Note that these emoji are only available on Time-series Pebbles due to hardware constraints.
* Made another attempt at fixing the charging modals. Third time's the charm!
### Changes to SDK
None. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.10.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.10.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1309
} |
---
# 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.
title: Pebble SDK 3.10 - Changelog
date: 2016-03-07
---
### Changes to Firmware
* Added energy (Calorie) usage to the Health app.
* Changed "till" to "'til" in the low battery modals.
* ``rand`` is now seeded from the hardware RNG on app start, as it was in firmware 3.4 and
earlier.
* Notifications containing only an emoji will now fill the screen with that emoji, if that
emoji supports this.
* Added support for filtering notifications by app on iOS (requires iOS app 3.10).
* Fixed a window stack crash affecting some 2.x apps running on 3.9 watches.
* Fixed an error on Pebble Classic and Pebble Steel where reminders did not include their
description.
* An issue causing the sleep graph to sometimes be blank on the deep sleep display of the
Health app was resolved.
* Improved Health accuracy.
* Improved firmware stability.
### Changes to SDK
* Added support for debugging apps with gdb, in conjunction with pebble tool 4.2.
* Added ``health_service_get_measurement_system_for_display`` to retrieve the user's unit preference.
* Added ``health_service_sum_averaged`` and ``health_service_metric_averaged_accessible`` to access
average health data. These can be used to determine the goal line used by the Pebble Health app.
* Added ``HealthMetricRestingKCalories`` and ``HealthMetricActiveKCalories`` to retrieve Calorie burn
information from Pebble Health.
* `CFLAGS` and `LINKFLAGS` env variables are now correctly honored by the app build process.
* JSON files under the `src/js/` directory are available to `require` in newly-created projects.
* ``persist_write_bool`` and ``persist_write_int`` are now correctly documented to return the
number of bytes written on success. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.10.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.10.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2283
} |
---
# 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.
title: Pebble SDK 3.11.1 - Changelog
date: 2016-04-04 15:00:00
---
This is a hotfix for [SDK 3.11](/sdk/changelogs/3.11/)
### Changes to Firmware
* Removed a non-functional app called `JavascriptTest` from the launcher menu.
### Changes to SDK
None. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.11.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.11.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 832
} |
---
# 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.
title: Pebble SDK 3.11 - Changelog
date: 2016-04-04
---
### Changes to Firmware
* Added a vibrations settings menu with new custom vibration patterns.
* Added sleep classification for naps and a pin to the timeline when a nap is completed.
* Changed the cutoff time for completed sleep sessions to be 9pm so sleep sessions ending after 9pm are recorded on the following day.
* Sleep summary screens are now hidden if no sleep data is collected overnight, and sleep graphs are hidden if no sleep data has been collected for the last week.
* Added a pin to the timeline when a long walk or run is completed, displaying distance, calorie burn and duration.
* Improved step-counting algorithm for Pebble Health.
* Fixed display of jumboji for larger font sizes.
* Fixed bug causing app resources not to be removed when uninstalling an application.
* Fixed watch reset on disconnecting smartstrap during communication.
* Fixed replying to SMS on iOS when a notification contains an attachment.
* Improved low battery screen and icons.
* Improved rendering of upper-case accented characters.
* Fixed watch crash caused by invalid ANCS messages that occur when two notification-receiving devices are connected.
* Fixed bug causing the "Dismiss" action to delete voicemails when a "Dismiss" option is not available for the notification in iOS.
* Fixed never-ending phone calls on iOS8 when a second phone call is received before the first call is ended.
* Fixed a watch crash when using the "Send Text" app caused by an animation not being cleaned up.
### Changes to SDK
* Added new ``gdraw_command_frame_get_command_list`` API.
* Fixed project build failures when the project path contained unicode.
### Changes to Documentation
* Added documentation of method arguments for ``smartstrap_set_timeout``, ``smartstrap_service_is_available``, ``smartstrap_attribute_get_service_id``, ``smartstrap_attribute_get_attribute_id``, and ``smartstrap_attribute_end_write``.
* Improved description of ``CompassHeadingData`` and how to convert to a heading using ``CompassHeadingData``. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.11.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.11.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2652
} |
---
# 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.
title: Pebble SDK 3.12 and 3.12.1 - Changelog
date: 2016-05-10
---
### Changes to Firmware
* Added Smart Alarms, which are smarter than regular alarms because they try to avoid waking you from a deep sleep.
* Added support for the Send Text app on iOS with Time-series watches and supported carriers.
* iOS users with Time-series watches and supported carriers can now respond to phone calls with text messages.
* Added Pebble Health notifications for runs and long walks, and daily activity and sleep.
* Added notification icons for Amazon, LinkedIn, Slack, Google Maps, Google Photos and the iOS Photos app (only on Time-series watches).
* Restored the ability to control general vibration strength (lost in 3.11 on Time-series watches).
* Removed weekly activity and sleep charts from the health app (they're in the phone app now).
* The default watchface, TicToc, is now written in and running as JavaScript on Pebble Time and Pebble Time Steel.
* ``health_service_get_minute_history`` now correctly rounds the start time down to the nearest minute.
* Fixed an issue where snooze on reminders sometimes never reminded you again.
* Fixed popups still showing after entering low-power mode.
* Fixed a crash when a notification is dismissed on the phone while performing a voice reply to that notification.
* Fixed the watch briefly freezing after backing out of a progress window.
* Fixed some incorrect timezone data.
* Improved rendering of the sleep ring in the Health app after more than twelve hours of sleep.
* Improved rendering of adjacent deep sleep sessions in the Health app.
### Changes to SDK
* Each line of build output now indicates which platform it applies to.
### Changes to Documentation
* Improved description of ``MenuLayer``-related constants. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.12.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.12.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 2352
} |
---
# 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.
title: Pebble SDK 3.13 - Changelog
date: 2016-06-10
---
This is a hotfix for [SDK 3.13](/sdk/changelogs/3.13/). This is an SDK-only
release; no corresponding firmware exists.
### Changes to SDK
* Use the value of package.json's `pebble.displayName` for the app's name
everywhere, instead of sometimes using `name`, which is subject to npm naming
restrictions.
* When using a block AppMessage key (e.g. `Elements[6]`), the name of the base
key is no longer usable directly and must be accessed numerically. This change
was made to ensure that it _could_ be accessed numerically, which is the
standard use-case for these array-like keys.
* Library capabilities (e.g. `location`) are now correctly merged with app
capabilities. | {
"source": "google/pebble",
"title": "devsite/source/_changelogs/3.13.1.md",
"url": "https://github.com/google/pebble/blob/main/devsite/source/_changelogs/3.13.1.md",
"date": "2025-01-21T21:11:59",
"stars": 4407,
"description": "This is the latest version of the internal repository from Pebble Technology providing the software to run on Pebble watches. Proprietary source code has been removed from this repository and it will not compile as-is. This is for information only.",
"file_size": 1318
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.