rpi/domo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update json file to new format

Browse Source
This commit is contained in:
jbnadal
2018-04-30 13:57:53 +02:00
parent af9fed68e8
commit c29d356fc2
13 changed files with 326 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
bsp/board/domo/ovl/usr/local/configs/restd/core.json
View File

@@ -1,53 +0,0 @@
// Comments
{
"controller": [
{
"model": "get",
"endpoint": ["/v1/capabilities"],
"ubus": {
"path": "domo.capabilities",
"method": "get"
}
},
{
"model": "get",
"endpoint": ["/v1/capabilities/lights", "/v1/capabilities/lights/:id"],
"ubus": {
"path": "domo.capabilities.lights",
"method": "get"
}
},
{
"model": "get",
"endpoint": ["/v1/capabilities/shutters", "/v1/capabilities/shutters/:id"],
"ubus": {
"path": "domo.capabilities.shutters",
"method": "get"
}
},
{
"model": "get",
"endpoint": ["/v1/capabilities/sprinklers", "/v1/capabilities/sprinklers/:id"],
"ubus": {
"path": "domo.capabilities.sprinklers",
"method": "get"
}
},
{
"model": "put",
"endpoint": ["/v1/capabilities/sprinklers/:id/open"],
"ubus": {
"path": "domo.capabilities.sprinklers.open",
"method": "open"
}
},
{
"model": "put",
"endpoint": ["/v1/capabilities/sprinklers/:id/close"],
"ubus": {
"path": "domo.capabilities.sprinklers.close",
"method": "close"
}
}
]
}

45
bsp/board/domo/ovl/usr/local/configs/restd/v1-lights.json Normal file
View File

@@ -0,0 +1,45 @@
// Lights
{
"resources": [
{
"model": "post",
"endpoint": "/v1/lights",
"ubus": {
"path": "domo.lights",
"method": "create"
}
},
{
"model": "get",
"endpoint": "/v1/lights",
"ubus": {
"path": "domo.lights",
"method": "list"
}
},
{
"model": "get",
"endpoint": "/v1/lights/:id",
"ubus": {
"path": "domo.lights",
"method": "read"
}
},
{
"model": "put",
"endpoint": "/v1/lights/:id",
"ubus": {
"path": "domo.lights",
"method": "update"
}
},
{
"model": "delete",
"endpoint": "/v1/lights/:id",
"ubus": {
"path": "domo.lights",
"method": "delete"
}
}
]
}

45
bsp/board/domo/ovl/usr/local/configs/restd/v1-sequences.json Normal file
View File

@@ -0,0 +1,45 @@
// Sequences
{
"resources": [
{
"model": "post",
"endpoint": "/v1/sequences",
"ubus": {
"path": "domo.sequences",
"method": "create"
}
},
{
"model": "get",
"endpoint": "/v1/sequences",
"ubus": {
"path": "domo.sequences",
"method": "list"
}
},
{
"model": "get",
"endpoint": "/v1/sequences/:id",
"ubus": {
"path": "domo.sequences",
"method": "read"
}
},
{
"model": "put",
"endpoint": "/v1/sequences/:id",
"ubus": {
"path": "domo.sequences",
"method": "update"
}
},
{
"model": "delete",
"endpoint": "/v1/sequences/:id",
"ubus": {
"path": "domo.sequences",
"method": "delete"
}
}
]
}

45
bsp/board/domo/ovl/usr/local/configs/restd/v1-shutters.json Normal file
View File

@@ -0,0 +1,45 @@
// Shutters
{
"resources": [
{
"model": "post",
"endpoint": "/v1/shutters",
"ubus": {
"path": "domo.shutters",
"method": "create"
}
},
{
"model": "get",
"endpoint": "/v1/shutters",
"ubus": {
"path": "domo.shutters",
"method": "list"
}
},
{
"model": "get",
"endpoint": "/v1/shutters/:id",
"ubus": {
"path": "domo.shutters",
"method": "read"
}
},
{
"model": "put",
"endpoint": "/v1/shutters/:id",
"ubus": {
"path": "domo.shutters",
"method": "update"
}
},
{
"model": "delete",
"endpoint": "/v1/shutters/:id",
"ubus": {
"path": "domo.shutters",
"method": "delete"
}
}
]
}

61
bsp/board/domo/ovl/usr/local/configs/restd/v1-sprinklers.json Normal file
View File

@@ -0,0 +1,61 @@
// Sprinklers
{
"resources": [
{
"model": "post",
"endpoint": "/v1/sprinklers",
"ubus": {
"path": "domo.sprinklers",
"method": "create"
}
},
{
"model": "get",
"endpoint": "/v1/sprinklers",
"ubus": {
"path": "domo.sprinklers",
"method": "list"
}
},
{
"model": "get",
"endpoint": "/v1/sprinklers/:id",
"ubus": {
"path": "domo.sprinklers",
"method": "read"
}
},
{
"model": "put",
"endpoint": "/v1/sprinklers/:id",
"ubus": {
"path": "domo.sprinklers",
"method": "update"
}
},
{
"model": "delete",
"endpoint": "/v1/sprinklers/:id",
"ubus": {
"path": "domo.sprinklers",
"method": "delete"
}
},
{
"model": "put",
"endpoint": "/v1/sprinklers/:id/open",
"ubus": {
"path": "domo.sprinklers.open",
"method": "open"
}
},
{
"model": "put",
"endpoint": "/v1/sprinklers/:id/close",
"ubus": {
"path": "domo.sprinklers.close",
"method": "close"
}
}
]
}

13
bsp/board/domo/ovl/usr/local/configs/restd/v1.json Normal file
View File

@@ -0,0 +1,13 @@
// Root
{
"resources": [
{
"model": "get",
"endpoint": "/v1/device-capabilities",
"ubus": {
"path": "domo.devices.capabilities",
"method": "list"
}
}
]
}

19
bsp/board/domo/ovl/usr/local/share/domo/capabilities.json
View File

@@ -1,7 +1,16 @@
{ {
"capabilities":[ "capabilities": [
"lights", {
"shutters", "name": "lights",
"sprinklers" "speach_name": "lumière"
},
{
"name": "shutters",
"speach_name": "volet"
},
{
"name": "sprinklers",
"speach_name": "station"
}
] ]
} }

137
bsp/board/domo/ovl/usr/local/share/domo/devices.json
View File

@@ -1,74 +1,65 @@
{ {
"lights" : { "lights": [
"speach_name": "lumière", {
"devices": [ "id": 1,
{ "name": "Bureau JB",
"id": 1, "speach_name": "bureau",
"name": "Bureau JB", "zone": "",
"speach_name": "bureau", "state": true,
"zone": "", "sender": 12797322,
"state": true, "interruptor": 0
"sender": 12797322, },
"interruptor": 0 {
}, "id": 2,
{ "name": "Salon",
"id": 2, "speach_name": "salon",
"name": "Salon", "zone": "",
"speach_name": "salon", "state": false,
"zone": "", "sender": 12797322,
"state": false, "interruptor": 1
"sender": 12797322, },
"interruptor": 1 {
}, "id": 3,
{ "name": "Sapin",
"id": 3, "speach_name": "sapin",
"name": "Sapin", "zone": "",
"speach_name": "sapin", "state": false,
"zone": "", "sender": 12797322,
"state": false, "interruptor": 2
"sender": 12797322, }
"interruptor": 2 ],
} "shutters": [
] {
}, "id": 1,
"shutters" : { "name": "Chambre de JB",
"speach_name": "volet", "zone": "",
"devices": [ "state": true,
{ "sender": 14997046,
"id": 1, "interruptor": 12,
"name": "Chambre de JB", "speed_up": 20,
"zone": "", "speed_down": 18
"state": true, }
"sender": 14997046, ],
"interruptor": 12, "sprinklers": [
"speed_up": 20, {
"speed_down": 18 "id": 7,
} "name": "Zone A",
] "state": false
}, },
"sprinklers" : { {
"speach_name": "station", "id": 8,
"devices": [ "name": "Zone B",
{ "state": false
"id": 7, },
"name": "Zone A", {
"state": false "id": 25,
}, "name": "Zone C",
{ "state": false
"id": 8, },
"name": "Zone B", {
"state": false "id": 24,
}, "name": "Zone D",
{ "state": false
"id": 25, }
"name": "Zone C", ]
"state": false }
},
{
"id": 24,
"name": "Zone D",
"state": false
}
]
}
}

12
docs/api/.vuepress/config.js Normal file
View File

@@ -0,0 +1,12 @@
module.exports = {
base: '.',
title: 'Domo Api 1.0',
description: 'domo API',
themeConfig: {
sidebar: [
'/',
['/ history', 'History'],
['/ capabilities', 'Capabilities'],
]
}
}

12
docs/api/README.md Normal file
View File

@@ -0,0 +1,12 @@
# Domo API documentation
## Quick overview
This documentation allow you to control the domo system.
## API design
http://dev.enchant.com/api/v1
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#useful-post-responses
https://restfulapi.net/resource-naming/

2
docs/api/device-management.md Normal file
View File

@@ -0,0 +1,2 @@
/device-management/capabilities

7
docs/api/history.md Normal file
View File

@@ -0,0 +1,7 @@
Revision History
================
| Current Version | Date | Description |
| --------------- | ------------------- | -------------- |
| 1.1 | | current update |
| 1.0 | February 07th, 2014 | First Draft |

6
docs/api/package.json Normal file
View File

@@ -0,0 +1,6 @@
{
"scripts": {
"docs:dev": "vuepress dev .",
"docs:build": "vuepress build"
}
}