EscapePod Extension SDK for Python
by cyb3rdog
This is the EscapePod Python SDK for Cyb3rVector's EscapePod Extension Proxy.
With this SDK, you can:
- maintain all your EscapePod intents from Python code
- dynamically create new extension intents from code
- react to and override all Vector's voice commands, including those created on the fly
- and more...
Getting Started
-
Use of this SDK assumes some familiarity and experience with Vector Python SDK, as well as ownership of the Anki/DDL Vector and DDL EscapePod.
-
In order to use this SDK to its full potential, it is recommended to have also the vector-python-sdk installed, as at this moment, this is the only Vector Python SDK, which can be used with your EscapePod onboarded Vector.
-
This SDK requires the Cyb3rVector Extension Proxy service to be deployed and configured to use with your EscapePod see the deployment guide
EscapePod SDK Installation
- Note: Use either
piporpip3correspondingly to the Python version you are using.
To install this SDK, run:
pip install escapepod_sdkorpip3 install escapepod_sdk
To upgrade this SDK to its latest version, use:
pip install escapepod_sdk --upgradeorpip3 install escapepod_sdk --upgrade
If you want to know where the SDK files are installed, use following command:
- Windows:
py -c "import escapepod_sdk as _; print(_.__path__)" - Linux:
python3 -c "import escapepod_sdk as _; print(_.__path__)"
Extension Deployement
Please see the deployment guide here.
EscapePod Extension Proxy itself, and its source code is maintained in separate repository: cyb3rdog/escape-pod-proxy.
Tutorials
To learn how to this SDK, start with tutorial example programs in the examples folder.
Logging
In order to change the log level to other then default value of INFO, set the SDK_LOG_LEVEL enviroment variable:
Allowed values are:
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
WARNING = 30
WARN = WARNING
INFO = 20
DEBUG = 10
Example:
- Windows:
SET SDK_LOG_LEVEL=DEBUG - Lunux:
SDK_LOG_LEVEL="DEBUG"
157 Nov 11, 2022
238 Sep 21, 2022
114 Dec 11, 2022
118 Sep 23, 2022
3.3k Dec 26, 2022
48 May 4, 2022
72 Aug 22, 2022
24 Dec 5, 2022
5 Oct 28, 2022
1 Nov 08, 2021
106 Dec 13, 2022
1 Dec 22, 2021
3 Sep 12, 2021
3 Dec 28, 2022
2 Dec 22, 2021
3 Oct 07, 2021
1 Dec 22, 2021
4 Mar 18, 2022
3 Jan 29, 2022
2 Dec 11, 2022
145 Dec 30, 2022
8 Dec 19, 2022
2 Oct 04, 2022
3 Dec 14, 2022
3.5k Jan 02, 2023
62 Sep 05, 2021
2 Feb 09, 2022
0 May 12, 2022
4 Sep 27, 2021