https://github.com/openvoiceos/ovos-backend-client
client library for interaction with all compatible ovos-core backend services
https://github.com/openvoiceos/ovos-backend-client
hacktoberfest
Last synced: about 1 year ago
JSON representation
client library for interaction with all compatible ovos-core backend services
- Host: GitHub
- URL: https://github.com/openvoiceos/ovos-backend-client
- Owner: OpenVoiceOS
- License: apache-2.0
- Archived: true
- Created: 2021-12-16T17:58:18.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-11-11T18:05:40.000Z (over 1 year ago)
- Last Synced: 2025-04-29T08:07:01.475Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Python
- Homepage:
- Size: 332 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OVOS Backend Client
Python client library for interaction with several supported backends under a single unified interface
- Personal backend - [self hosted](https://github.com/OpenVoiceOS/OVOS-local-backend)
- Offline - support for setting your own api keys and query services directly
## Backend Overview
| API | Offline | Personal |
|-----------|---------|----------|
| Admin | yes [1] | yes |
| Device | yes | yes |
| Metrics | yes | yes |
| Dataset | yes | yes |
| OAuth | yes | yes |
| Wolfram | yes [2] | yes |
| Geolocate | yes | yes |
| STT | yes [2] | yes |
| Weather | yes [2] | yes |
| Email | yes [2] | yes |
[1] will update user level mycroft.conf
[2] needs additional configuration (eg. credentials)
[3] uses offline_backend functionality
## Geolocation
```python
from ovos_backend_client.api import GeolocationApi
geo = GeolocationApi()
data = geo.get_geolocation("Lisbon Portugal")
# {'city': 'Lisboa',
# 'country': 'Portugal',
# 'latitude': 38.7077507,
# 'longitude': -9.1365919,
# 'timezone': 'Europe/Lisbon'}
```
## OpenWeatherMap Proxy
```python
from ovos_backend_client.api import OpenWeatherMapApi
owm = OpenWeatherMapApi()
data = owm.get_weather()
# dict - see api docs from owm onecall api
```
DEPRECATED - weather skill now uses open meteo
## Wolfram Alpha proxy
```python
from ovos_backend_client.api import WolframAlphaApi
wolf = WolframAlphaApi()
answer = wolf.spoken("what is the speed of light")
# The speed of light has a value of about 300 million meters per second
data = wolf.full_results("2+2")
# dict - see api docs from wolfram
```
## STT
a companion stt plugin is available - [ovos-stt-plugin-selene](https://github.com/OpenVoiceOS/ovos-stt-plugin-selene)
DEPRECATED - use https://github.com/OpenVoiceOS/ovos-stt-plugin-server with a public server instead
## Remote Settings
To interact with skill settings on selene
```python
from ovos_backend_client.settings import RemoteSkillSettings
# in ovos-core skill_id is deterministic and safe
s = RemoteSkillSettings("skill.author")
# in mycroft-core please ensure a valid remote_id
# in MycroftSkill class you can use
# remote_id = self.settings_meta.skill_gid
# s = RemoteSkillSettings("skill.author", remote_id="@|whatever_msm_decided")
s.download()
s.settings["existing_value"] = True
s.settings["new_value"] = "will NOT show up in UI"
s.upload()
# auto generate new settings meta for all new values before uploading
s.settings["new_value"] = "will show up in UI"
s.generate_meta() # now "new_value" is in meta
s.upload()
```
## Selene Cloud
by hijacking skill settings we allows storing arbitrary data in selene and use it across devices and skills
```python
from ovos_backend_client.cloud import SeleneCloud
cloud = SeleneCloud()
cloud.add_entry("test", {"secret": "NOT ENCRYPTED MAN"})
data = cloud.get_entry("test")
```
an encrypted version is also supported if you dont trust selene!
```python
from ovos_backend_client.cloud import SecretSeleneCloud
k = "D8fmXEP5VqzVw2HE" # you need this to read back the data
cloud = SecretSeleneCloud(k)
cloud.add_entry("test", {"secret": "secret data, selene cant read this"})
data = cloud.get_entry("test")
```
## Admin Api (local backend only!)
since local backend does not provide a web ui a [admin api](https://github.com/OpenVoiceOS/OVOS-local-backend#admin-api)
can be used to manage your devices
```python
from ovos_backend_client.api import AdminApi
admin = AdminApi("secret_admin_key")
uuid = "..." # check identity2.json in the device you want to manage
# manually pair a device
identity_json = admin.pair(uuid)
# set device info
info = {"opt_in": True,
"name": "my_device",
"device_location": "kitchen",
"email": "notifications@me.com",
"isolated_skills": False,
"lang": "en-us"}
admin.set_device_info(uuid, info)
# set device preferences
prefs = {"time_format": "full",
"date_format": "DMY",
"system_unit": "metric",
"lang": "en-us",
"wake_word": "hey_mycroft",
"ww_config": {"phonemes": "HH EY . M AY K R AO F T",
"module": "ovos-ww-plugin-pocketsphinx",
"threshold": 1e-90},
"tts_module": "ovos-tts-plugin-mimic",
"tts_config": {"voice": "ap"}}
admin.set_device_prefs(uuid, prefs)
# set location data
loc = {
"city": {
"code": "Lawrence",
"name": "Lawrence",
"state": {
"code": "KS",
"name": "Kansas",
"country": {
"code": "US",
"name": "United States"
}
}
},
"coordinate": {
"latitude": 38.971669,
"longitude": -95.23525
},
"timezone": {
"code": "America/Chicago",
"name": "Central Standard Time",
"dstOffset": 3600000,
"offset": -21600000
}
}
admin.set_device_location(uuid, loc)
```