Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
Line 64: Line 64:
 
* <code>https://olekdia.com/pranabreath/Trainings/5?name=Balance</code> - Rename a training with equals 5, set name as "Balance".
 
* <code>https://olekdia.com/pranabreath/Trainings/5?name=Balance</code> - Rename a training with equals 5, set name as "Balance".
 
|-
 
|-
−
| '''info'''
+
| '''public_id'''
−
|
+
| Indicates public id of the training. All [[Training_type|trainings in this list]] have their own ''public_id''. Readonly value.
 +
* <code>pranabreath://trngs?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training.
 +
|-
 +
| '''curr_level'''
 +
| Selected [[Complexity level|complexity level]] of a training (if applicable). Value range is [1, 5]
 +
* <code>pranabreath://1?curr_level=3</code> - Set complexity level to "Advanced" for [[Clear_mind|clear mind training]]
 +
 
 
|}
 
|}

Revision as of 11:49, 31 January 2019

trainings

trainings - collection gives you access to all trainings on the device.
Aliases: trng

Commands:

Command Description
list Returns training list. Currently it is only used in console for retrieving training list.
  • pranabreath://trainings?cmd=list
pos id public_id name
0   1  1         Clear mind
1   2  2         Relax
2   3  3         Calming
3   4  4         Power
4   5  5         Harmony
5   6  6         Anti-stress
6   7  7         Anti-appetite
7   8  8         Cigarette replace
8   9  11        Bhastrika
  • pranabreath://trainings - It is a default command when only collection is defined without an item, so if we omit the command it will return the same result.
import Import the specified training into the app.
create Create the training with defined parameters.
  • pranabreath://trainings?cmd=create&name=Serenity&trng_type=1 - Create meditation with name "Serenity".
  • pranabreath://trainings?cmd=create&name=4_7_8_Breathing&dur_prep_time=5000&trng_cycles={"mValues":[{"mInhaleUnit":4,"mRetainUnit":7,"mExhaleUnit":8,"mMethodsBitSet":129,"mSecPerUnit":1000}],"mKeys":[0,]} - Create training with name "4_7_8_Breathing", with 5 seconds preparing time, and 4:7:8:0 ratio
start Starts the selected training. If there is no an entered training - nothing happens, if only the training name is set from public training list, in such case it will be imported automatically and started.
  • pranabreath://trainings/Clear_mind?cmd=start - Clear mind training will be selected and started. Also it will bring the app to foreground with Training tab selected.
  • pranabreath://trainings/Some_custom_name?cmd=start - If there is no "Some_custom_name" in the app - nothing happens.
  • pranabreath://trainings/2?cmd=start - Training with id == 2 will be selected and started.
  • pranabreath://trainings/Bhastrika?cmd=start - Training with name "Bhastrika" will be selected and started. If there is no such training Bhastrika training will be imported and started.
delete Delete the selected training. If there is no an entered training - nothing happens
info

Parameters:

Parameter Description
name Name of the training.
public_id Indicates public id of the training. All trainings in this list have their own public_id. Readonly value.
  • pranabreath://trngs?cmd=import&public_id=25 - Import training with public_id equals 25 which is Ha breathing training.
curr_level Selected complexity level of a training (if applicable). Value range is [1, 5]
Retrieved from "https://olekdia.com/index.php?title=Development:Prana_Breath_API&oldid=84359"