database/plan.txt

   1
   2 #
   3 # Database structure.
   4 #
   5
   6
   7 + Device DB
   8 \-+ TV                  Category
   9   \-+ Philips           Manufacturer
  10     \-+ PS55799446      Model
  11
  12
  13
  14
  15
  16 #
  17 # Reqister user to the database.
  18 #
  19
  20 <request>
  21         <type>registration</type>
  22         <nick>eXeonical</nick>
  23         <email>exeonical@iki.fi</email>
  24         <password>password-sha1-hash</password>
  25 </request>
  26
  27 #
  28 # On failure
  29 #
  30 <responce>
  31         <status>user-exists</status>
  32         <message>User already exists.</message>
  33 </responce>
  34
  35 #
  36 # On success
  37 #
  38 <responce>
  39         <status>registration-ok</status>
  40         <message>Registration succeeded.</message>
  41 </responce>
  42
  43
  44
  45 #
  46 # Get a list of categories available.
  47 #
  48
  49 <request>
  50         <type>category-list</type>
  51 </request>
  52
  53 <category>
  54         <name>
  55 </category>
  56
  57
  58
  59 #
  60 # Get list of manufacturers inside a category.
  61 #
  62
  63 <request>
  64         <type>manufacturer-list</type>
  65         <category>tv</category>
  66 </request>
  67
  68 <manufacturer>
  69         <name>Philips</name>
  70         <category>tv</category>
  71 </manufacturer>
  72
  73
  74
  75 #
  76 # Get list of models inside manufacturer.
  77 #
  78
  79 <request>
  80         <type>model-list</type>
  81         <category>tv</category>
  82 </request>
  83
  84 <model>
  85         <name>PS55799446</name>
  86         <id>1234</id>
  87         <manufacturer>Philips</manufacturer>
  88         <category>tv</category>
  89         <backend>IRTrans</backend>
  90 </model>
  91
  92
  93
  94 #
  95 # Get configuration file.
  96 #
  97
  98 <request>
  99         <type>get-config</type>
 100         <id>1234</id>
 101 </request>
 102
 103 <config>
 104         <backend>IRTrans</backend>
 105         <filename>remote.rem</filename>
 106         <hash>032wdfjslkdsjf0ds</hash>
 107         <data>IRTrans</data>
 108 </config>
 109
 110
 111
 112 #
 113 # Add configuration file.
 114 #
 115
 116 <request>
 117         <type>put-config</type>
 118         <nick>eXeonical</nick>
 119         <password>password-sha1-hash</password>
 120         <backend>IRTrans</backend>
 121         <category>TV</category>
 122         <manufacturer>Philips</manufacturer>
 123         <model>PS55799446</model>
 124         <filename>remote.rem</filename>
 125         <hash>032wdfjslkdsjf0ds</hash>
 126         <data>AAAAAAAAAa</data>
 127 </request>
 128
 129 <config>
 130         <status>config-saved</status>
 131         <message>User already exists.</message>
 132 </config>
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149