App Metadata

Project Defaults

After creating a new local SDK Pebble project, additional setup of the project behavior and metadata can be performed in the package.json file. By default, the pebble new-project command will create a template package.json metadata file, which can then be modified as required.

The generated package.json metadata looks like this:

{
  "name": "example-app",
  "author": "MakeAwesomeHappen",
  "version": "1.0.0",
  "keywords": ["pebble-app"],
  "private": true,
  "dependencies": {},
  "pebble": {
    "displayName": "example-app",
    "uuid": "5e5b3966-60b3-453a-a83b-591a13ae47d5",
    "sdkVersion": "3",
    "enableMultiJS": true,
    "targetPlatforms": [
      "aplite",
      "basalt",
      "chalk"
    ],
    "watchapp": {
      "watchface": false
    },
    "messageKeys": [
      "dummy"
    ],
    "resources": {
      "media": []
    }
  }
}

Note: The uuid (Universally Unique IDentifier) field should be unique (as the name implies) and always properly generated. To do this on Mac OS X or Linux, use the uuidgen tool or a web service. Due to format requirements, these should never be manually modified.

Available Properties

Options defined in package.json (Required fields shown in bold) are listed in the table below:

Note: hiddenApp and onlyShownOnCommunication are mutually exclusive. hiddenApp will always take preference.

Hidden Watchapp

The example below shows an example watchapp object for a watchapp that is hidden until communicated with from a companion app.

"watchapp": {
  "watchface": false,
  "hiddenApp": false,
  "onlyShownOnCommunication": true
}

Published Media

Introduced in SDK 4.0, publishedMedia provides a mechanism for applications to specify image resources which can be used within AppGlance Slices or Timeline Pins.

The publishedMedia object allows your watchapp, Pebble mobile application and Pebble web services to determine which image resources to use, based on a static ID. Without this lookup table, the components would not be able to establish the correct resources to use after an update to the watchapp.

Let's take a look at the structure of publishedMedia in more detail.

We'll start by declaring some image resources which we can reference in publishedMedia later. In this example we have 'hot' and 'cold' icons, in 3 different sizes.

"resources": {
  "media": [
    {
      "name": "WEATHER_HOT_ICON_TINY",
      "type": "bitmap",
      "file": "hot_tiny.png"
    },
    {
      "name": "WEATHER_HOT_ICON_SMALL",
      "type": "bitmap",
      "file": "hot_small.png"
    },
    {
      "name": "WEATHER_HOT_ICON_LARGE",
      "type": "bitmap",
      "file": "hot_large.png"
    },
    {
      "name": "WEATHER_COLD_ICON_TINY",
      "type": "bitmap",
      "file": "cold_tiny.png"
    },
    {
      "name": "WEATHER_COLD_ICON_SMALL",
      "type": "bitmap",
      "file": "cold_small.png"
    },
    {
      "name": "WEATHER_COLD_ICON_LARGE",
      "type": "bitmap",
      "file": "cold_large.png"
    }
  ]
}

Next we declare the publishedMedia:

"resources": {
  // .....
  "publishedMedia": [
    {
      "name": "WEATHER_HOT",
      "id": 1,
      "glance": "WEATHER_HOT_ICON_TINY",
      "timeline": {
        "tiny": "WEATHER_HOT_ICON_TINY",
        "small": "WEATHER_HOT_ICON_SMALL",
        "large": "WEATHER_HOT_ICON_LARGE"
      }
    }, {
      "name": "WEATHER_COLD",
      "id": 2,
      "glance": "WEATHER_COLD_ICON_TINY",
      "timeline": {
        "tiny": "WEATHER_COLD_ICON_TINY",
        "small": "WEATHER_COLD_ICON_SMALL",
        "large": "WEATHER_COLD_ICON_LARGE"
      }
    }
  ]
}

As you can see above, we can declare multiple entries in publishedMedia.

Let's look at the properties in more detail:

• name - This must be a unique alias to reference each entry of the publishedMedia object. We use the name for the AppGlanceSlice icon or Timeline Pin icon, and the system will load the appropriate resource when required. The naming convention varies depending on where it's being used. For example, the AppGlance C API prefixes the name: PUBLISHED_ID_WEATHER_HOT but the other APIs use: app://images/WEATHER_HOT.
• id - This must be a unique number within the set of publishedMedia. It must be greater than 0.
• glance - Optional. This references the resource image which will be displayed if this publishedMedia is used as the icon of an AppGlanceSlice. Size: 25x25.
• timeline - Optional. This references the resource images which will be displayed if this publishedMedia is used for the various sizes of a timeline icon. All three sizes must be specified. Sizes: Tiny 25x25, Small 50x50, Large 80x80.

Your publishedMedia entry must include either glance, timeline, or both. If you specify glance and timeline, the glance must be the same resource as timeline.tiny. If you remove a publishedMedia entry, you must not re-use the ID.