Introduction
When you work with multiple country and different timezone, you’re always wondering what time it is there… And I was fed up to keep opening a tab in a browser to find out again and again.
So I decided to create a kalliopé neuron to be able to ask kalliopé what time it is in any city / country :) and I create the [wwtime neuron]https://github.com/bacardi55/kalliope-wwtime() to do so!
How
Getting timezone for address
This neuron will retrieve a local timezone and a requested city timezone. It compares timezone difference (including summer time) between the two location to give you the time there based on your timezone.
Eg:
- I am in Paris (GMT +1)
- I want to know Boston time (GMT -5 - and as of now - summer time (so 1 additional hour))
When it’s 10pm in Paris, Kalliope will tell me it is 5pm in Boston (because as of now, boston is in summer time and paris not yet, so -5 and not -6)
It uses GoogleMaps API to get geolocation data based on a city name or address. So you need to activate to Google API:
To make it works, you will need to get an API key on your developer console. Or follow documentation here and here
Installation
kalliope install --git-url https://github.com/bacardi55/kalliope-wwtimes.git
Options
| parameter | required | default | choices | comment |
|---|---|---|---|---|
| gmaps_api_key | yes | string | The api key to use googlemaps API. See above. | |
| local | yes | string | Your city/address to compare time difference with | |
| city | yes | string | What city/address where you want to know time |
Return Values
| Name | Description | Type | sample |
|---|---|---|---|
| status | Response status | String | OK or KO |
| city | A dict¹ (see below) | dict | [arg: ’new york city’, ’timezoneid’: ‘America/New_York’, ’timezonename’: ‘Eastern Daylight Time’, time: {‘hour’: ‘10’, ‘minute’: ‘30’}] |
| local | A dict¹ (see below) | dict | [arg: ‘Paris France’, ’timezoneid’: ‘Europe/Paris’, ’timezonename’: ‘Central European Standard Time’, time: {‘hour’: ‘10’, ‘minute’: ‘30’}] |
¹: these dict contains:
- arg: The given name in arguments (equals ’local’ argument for local return variable or ‘city’ arguments for city return variable)
- timezoneid: The ID of the timezone, eg: Europe/Paris
- timezonename: The name of the timezone eg: Central European Standard Time
- time, a dict containing ‘hour’ and ‘minutes’
Synapses example
brains
Get a city by argument in order
- name: "Wwtime-city"
signals:
- order: "what time is it in {{city}}"
neurons:
- wwtime:
gmaps_api_key: "{{gmaps_api_key}}"
local: "Paris France"
args:
- city
file_template: "templates/fr_wwtime.j2"
Get a city by argument set in brain:
- name: "Wwtime-city-boton"
signals:
- order: "heure boston"
neurons:
- wwtime:
gmaps_api_key: "{{gmaps_api_key}}"
city: "boston MA"
local: "Paris France"
file_template: "templates/fr_wwtime.j2"
template
{% raw %}
{% if status == "OK" %}
Sir, in {{city.arg}}, it is {{city.time.hour}} hour and {{city.time.minute}} minutes, whereas here, it's {{local.time.hour}} hour and {{local.time.minute}} minutes
Le timezone est {{city.timezonename}}
{% else %}
Sorry sir, but I don't know
{% endif %}
{% endraw %}
see more example in the sample directory