mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-11-14 15:04:03 -08:00
69 lines
3.4 KiB
Plaintext
69 lines
3.4 KiB
Plaintext
---
|
|
id: owm
|
|
title: Open Weather Map
|
|
sidebar_label: Open Weather Map
|
|
---
|
|
|
|
## What
|
|
|
|
Shows the current weather of a given location with [Open Weather Map][owm].
|
|
|
|
:::caution
|
|
You **must** request an API key at the [Open Weather Map][owm-price] website.
|
|
The free tier for _Current weather and forecasts collection_ is sufficient.
|
|
:::
|
|
|
|
## Sample Configuration
|
|
|
|
```json
|
|
{
|
|
"type": "owm",
|
|
"style": "powerline",
|
|
"powerline_symbol": "\uE0B0",
|
|
"foreground": "#ffffff",
|
|
"background": "#FF0000",
|
|
"template": "{{.Weather}} ({{.Temperature}}{{.UnitIcon}})",
|
|
"properties": {
|
|
"apikey": "<YOUR_API_KEY>",
|
|
"location": "AMSTERDAM,NL",
|
|
"units": "metric",
|
|
"http_timeout": 20,
|
|
"cache_timeout": 10
|
|
}
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Name | Type | Description |
|
|
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `apikey` | `string` | Your API key from [Open Weather Map][owm] |
|
|
| `location` | `string` | The requested location. Formatted as <City,STATE,COUNTRY_CODE>. City name, state code and country code divided by comma. Please, refer to ISO 3166 for the state codes or country codes - defaults to `DE BILT,NL` |
|
|
| `units` | `string` | Units of measurement. Available values are standard (kelvin), metric (celsius), and imperial (fahrenheit) - defaults to `standard` |
|
|
| `http_timeout` | `int` | The default timeout for http request is 20ms. |
|
|
| `cache_timeout` | `int` | The default timeout for request caching is 10m. A value of 0 disables the cache. |
|
|
| `template` | `string` | A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `{{.Weather}} ({{.Temperature}}{{.UnitIcon}})` |
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
```template
|
|
{{ .Weather }} ({{ .Temperature }}{{ .UnitIcon }})
|
|
```
|
|
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| -------------- | -------- | ---------------------------------------------- |
|
|
| `.Weather` | `string` | the current weather icon |
|
|
| `.Temperature` | `int` | the current temperature |
|
|
| `.UnitIcon` | `string` | the current unit icon(based on units property) |
|
|
| `.URL` | `string` | the url of the current api call |
|
|
|
|
[templates]: /docs/configuration/templates
|
|
[owm]: https://openweathermap.org
|
|
[owm-price]: https://openweathermap.org/price
|