From 07f5132654aea44dd7bbefb654f8847f9efa8bcf Mon Sep 17 00:00:00 2001 From: Chavee Issariyapat Date: Fri, 30 Sep 2016 09:22:19 +0700 Subject: [PATCH 1/4] Update README.th.md --- README.th.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.th.md b/README.th.md index 4bd2f27..ee89c41 100644 --- a/README.th.md +++ b/README.th.md @@ -38,11 +38,14 @@ topic เป็นจุดแลกเปลี่ยน message ระหว #### Microgear microgear คือ device ที่เชื่อมต่อกับ NETPIE เราสามารถสื่อสารตรงไปที่ microgear โดยอ้างอิงชื่อ alias ที่ตั้งให้ device นั้น +#### Feed +feed เป็นพื้นที่สำหรับเก็บข้อมูลแบบ time series ซึ่งเป็นข้อมูลตัวเลขที่ stamp เวลา แต่ละ feed จะอ้างอิงด้วย feedid ที่เราสร้างขึ้นมา + #### Postbox postbox เป็นพื้นที่สำหรับเก็บข้อมูลแบบ queue โดย message ที่ถูกส่งเข้าไปใน postbox จะถูกเก็บสะสมไว้ จนกว่าจะมีการอ่านออกไป message ที่ถูกอ่านแล้วจะหายไปจาก postbox ทันที เหมาะที่จะใช้เป็นเครื่องมือสื่อสารกับ microgear ที่ไม่สามารถ online ได้ตลอดเวลา เช่น PHP script --- -#### topic +#### Topic -- **PUT /topic/**_{appid}_**/**_{topic}_ @@ -78,7 +81,7 @@ $ curl -X GET "https://api.netpie.io/topic/myappid/home/bedroom/light" -u jVjzJX ``` --- -#### microgear +#### Microgear -- **PUT /microgear/**_{appid}_**/**_{gearalias}_ @@ -88,6 +91,44 @@ $ curl -X GET "https://api.netpie.io/topic/myappid/home/bedroom/light" -u jVjzJX Body * message ที่จะส่ง เป็น plain text string หากมีการ encode ด้วยรูปแบบ json ทางปลายทางจะต้องนำ string ไป parse เอง +--- +#### Feed +-- + +**GET /feed/**_{feedid}_ + +อ่านข้อมูลจาก feed ชื่อ *feedid* + +URL parameter +* *apikey* รหัสลับที่สร้างขึ้นบนเว็บ ใช้ตรวจสอบว่ามีสิทธิ์ในการอ่าน feed จริงหรือเปล่า + +Body +* *data* ลิสต์ของชื่อข้อมูลที่จะอ่าน ในรูปแบบ name1,name2,... หากไม่กำหนด จะอ่านทั้งหมด +* *granularity* ค่าความละเียดของจุดข้อมูล อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ +เป็นได้ดังนี้ second, minute, hour, day, week, month, year +* *since* ระยะเวลาล่าสุดที่จะดึงข้อมูลออกมา อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ +เป็นได้ดังนี้ second, minute, hour, day, week, month, year + +ตัวอย่าง +``` +$ curl -X GET "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk&granularity=10minute&since=24hour" +``` + +**PUT /feed/**_{feedid}_ + +บันทึกข้อมูลลง feed ชื่อ *feedid* + +URL parameter +* *apikey* รหัสลับที่สร้างขึ้นบนเว็บ ใช้ตรวจสอบว่ามีสิทธิ์ในการเขียน feed จริงหรือเปล่า + +Body +* *data* ข้อมูลที่จะบันทึก อยู่ในรูปแบบ name1:value1,name2:value2,... +* *timestamp* ค่า timestamp ของเวลาในหน่วย ms (หากไม่ระบุ server จะใช้เวลาปัจจุบันแทน) + +ตัวอย่าง +``` +$ curl -X PUT "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk" -d "temp=25.7,humid=52.4,light=9.2×tamp=1475061604173" +``` --- #### Postbox From 781b957d6c1316a7d2167077742c87b41de3cb8a Mon Sep 17 00:00:00 2001 From: Chavee Issariyapat Date: Fri, 30 Sep 2016 10:35:04 +0700 Subject: [PATCH 2/4] Update README.th.md --- README.th.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.th.md b/README.th.md index ee89c41..4feab7c 100644 --- a/README.th.md +++ b/README.th.md @@ -101,14 +101,15 @@ Body URL parameter * *apikey* รหัสลับที่สร้างขึ้นบนเว็บ ใช้ตรวจสอบว่ามีสิทธิ์ในการอ่าน feed จริงหรือเปล่า - -Body * *data* ลิสต์ของชื่อข้อมูลที่จะอ่าน ในรูปแบบ name1,name2,... หากไม่กำหนด จะอ่านทั้งหมด -* *granularity* ค่าความละเียดของจุดข้อมูล อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ +* *granularity* ค่าความละเียดของจุดข้อมูล อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง เป็นได้ดังนี้ second, minute, hour, day, week, month, year -* *since* ระยะเวลาล่าสุดที่จะดึงข้อมูลออกมา อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ +* *since* ระยะเวลาล่าสุดที่จะดึงข้อมูลออกมา อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง เป็นได้ดังนี้ second, minute, hour, day, week, month, year +Body +* ไม่มี + ตัวอย่าง ``` $ curl -X GET "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk&granularity=10minute&since=24hour" @@ -127,7 +128,7 @@ Body ตัวอย่าง ``` -$ curl -X PUT "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk" -d "temp=25.7,humid=52.4,light=9.2×tamp=1475061604173" +$ curl -X PUT "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk" -d "data=temp:25.7,humid:52.4,light:9.2×tamp=1475061604173" ``` --- From 389ab4abdc25396e1395cbd9eee927de690d6fa1 Mon Sep 17 00:00:00 2001 From: Chavee Issariyapat Date: Fri, 30 Sep 2016 12:53:48 +0700 Subject: [PATCH 3/4] Update README.th.md --- README.th.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.th.md b/README.th.md index 4feab7c..5e1ba51 100644 --- a/README.th.md +++ b/README.th.md @@ -32,17 +32,13 @@ $ curl -X GET "http://www.domainname.com/resources?auth=john:secret" ``` --- ### Resource Types -#### Topic -topic เป็นจุดแลกเปลี่ยน message ระหว่าง microgear ลักษณะการเขียนจะอยู่ในรูปของ path เช่น /home/bedroom/temp โดย microgear สามารถ PUT/publish, GET/subscribe ไปที่ topic นี้ได้ +- **Topic** เป็นจุดแลกเปลี่ยน message ระหว่าง microgear ลักษณะการเขียนจะอยู่ในรูปของ path เช่น /home/bedroom/temp โดย microgear สามารถ PUT/publish, GET/subscribe ไปที่ topic นี้ได้ -#### Microgear -microgear คือ device ที่เชื่อมต่อกับ NETPIE เราสามารถสื่อสารตรงไปที่ microgear โดยอ้างอิงชื่อ alias ที่ตั้งให้ device นั้น +- **Microgear** คือ device ที่เชื่อมต่อกับ NETPIE เราสามารถสื่อสารตรงไปที่ microgear โดยอ้างอิงชื่อ alias ที่ตั้งให้ device นั้น -#### Feed -feed เป็นพื้นที่สำหรับเก็บข้อมูลแบบ time series ซึ่งเป็นข้อมูลตัวเลขที่ stamp เวลา แต่ละ feed จะอ้างอิงด้วย feedid ที่เราสร้างขึ้นมา +- **Feed** เป็นพื้นที่สำหรับเก็บข้อมูลแบบ time series ซึ่งเป็นข้อมูลตัวเลขที่ stamp เวลา แต่ละ feed จะอ้างอิงด้วย feedid ที่เราสร้างขึ้นมา -#### Postbox -postbox เป็นพื้นที่สำหรับเก็บข้อมูลแบบ queue โดย message ที่ถูกส่งเข้าไปใน postbox จะถูกเก็บสะสมไว้ จนกว่าจะมีการอ่านออกไป message ที่ถูกอ่านแล้วจะหายไปจาก postbox ทันที เหมาะที่จะใช้เป็นเครื่องมือสื่อสารกับ microgear ที่ไม่สามารถ online ได้ตลอดเวลา เช่น PHP script +- **Postbox** เป็นพื้นที่สำหรับเก็บข้อมูลแบบ queue โดย message ที่ถูกส่งเข้าไปใน postbox จะถูกเก็บสะสมไว้ จนกว่าจะมีการอ่านออกไป message ที่ถูกอ่านแล้วจะหายไปจาก postbox ทันที เหมาะที่จะใช้เป็นเครื่องมือสื่อสารกับ microgear ที่ไม่สามารถ online ได้ตลอดเวลา เช่น PHP script --- #### Topic @@ -101,7 +97,7 @@ Body URL parameter * *apikey* รหัสลับที่สร้างขึ้นบนเว็บ ใช้ตรวจสอบว่ามีสิทธิ์ในการอ่าน feed จริงหรือเปล่า -* *data* ลิสต์ของชื่อข้อมูลที่จะอ่าน ในรูปแบบ name1,name2,... หากไม่กำหนด จะอ่านทั้งหมด +* *filter* เปฌนตัวกรองเฉพาะข้อมูลตัวแปรที่ต้องการ ในรูปแบบ name1,name2,... หากไม่กำหนด จะได้ข้อมูลทั้งหมด * *granularity* ค่าความละเียดของจุดข้อมูล อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง เป็นได้ดังนี้ second, minute, hour, day, week, month, year * *since* ระยะเวลาล่าสุดที่จะดึงข้อมูลออกมา อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง From 01ba6969f66e907375b5fb7e3554d6ffd9b0b245 Mon Sep 17 00:00:00 2001 From: Chavee Issariyapat Date: Fri, 30 Sep 2016 13:11:15 +0700 Subject: [PATCH 4/4] Update README.th.md --- README.th.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.th.md b/README.th.md index 5e1ba51..a6149d6 100644 --- a/README.th.md +++ b/README.th.md @@ -97,7 +97,7 @@ Body URL parameter * *apikey* รหัสลับที่สร้างขึ้นบนเว็บ ใช้ตรวจสอบว่ามีสิทธิ์ในการอ่าน feed จริงหรือเปล่า -* *filter* เปฌนตัวกรองเฉพาะข้อมูลตัวแปรที่ต้องการ ในรูปแบบ name1,name2,... หากไม่กำหนด จะได้ข้อมูลทั้งหมด +* *filter* เป็นเงื่อนไขใช้กรองเฉพาะ attribute ที่ต้องการ ในรูปแบบ name1,name2,... หากไม่กำหนด จะได้ atribute ทั้งหมด * *granularity* ค่าความละเียดของจุดข้อมูล อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง เป็นได้ดังนี้ second, minute, hour, day, week, month, year * *since* ระยะเวลาล่าสุดที่จะดึงข้อมูลออกมา อยู่ในรูป ตัวเลขตามด้วยหน่วย ซึ่ง @@ -108,7 +108,7 @@ Body ตัวอย่าง ``` -$ curl -X GET "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk&granularity=10minute&since=24hour" +$ curl -X GET "https://api.netpie.io/feed/myfeedid?apikey=VFxz9XaJ2h8wdJk&granularity=10minute&filter=temp,humid&since=24hour" ``` **PUT /feed/**_{feedid}_