TeleSorting System API

User Manual

ระบบจัดเรียงของระยะไกล (TeleSorting System) ที่ทางโครงการจัดเตรียมไว้ให้มี 2 ระบบ การทำงานของระบบคล้ายคลึงกัน มีส่วนประกอบต่าง ๆ ได้แก่ Input, Sensor, Actuator, Output, และ Detection สำหรับส่วนการตรวจชิ้นงานความแตกต่างของแต่ละระบบอยู่ที่ Detection ของระบบที่ 1 ใช้กล้องตรวจสีของชิ้นงาน (Color Detection) ระบบที่ 2 ใช้การตรวจวัสดุของชิ้นงาน (Material Detection)

TeleSorting System API ถูกออกแบบให้ใช้งานในรูปแบบ REST API โดยมีการรับ-ส่งข้อมูลในรูปแบบ JSON และมีการใช้ GET และ POST ผู้ใช้งาน TeleSorting System API จำเป็นต้องมีความรู้เกี่ยวกับ HTTP Protocol

TeleSorting System – F1

ระบบจัดเรียงของระยะไกล ระบบที่ 1

ระบบจัดเรียงของระยะไกลระบบที่ 1 (TeleSorting System – F1) มีการแบ่งส่วนการทำงานแบ่งออกเป็น 10 ส่วน (Station) แต่ละ Station จะมี Sensor สำหรับตรวจจับชิ้นงานและ Actuator สำหรับผลักชิ้นงาน (Pneumatic Actuator) อย่างละ 1 ตัว

การทำงานของระบบเริ่มจากชิ้นงาน (Item) จะถูกป้อนเข้าสู่จุด Input บนสายพานเส้นหลัก (ตรงกลาง) จากนั้นกล้องตรวจจับสี (Vision System) จะทำหน้าที่ตรวจสีชิ้นงานและเก็บค่าสีของชิ้นงานเอาไว้ในระบบ สุดท้ายสายพานหลักจะลำเลียงชิ้นงานเคลื่อนที่ไปจนกระทั่งออกไปยังจุด Output และชิ้นงานจะวนกลับมาเข้าสู่จุด Input อีกครั้ง

ผู้ใช้งานสามารถเลือกสั่งงานอุปกรณ์ขับเคลื่อนจาก Station ใดก็ได้ เพื่อผลักชิ้นงานลงไปยังสายพานด้านล่าง เสมือนว่าเป็นกระบวนการคัดแยกสินค้า

ตัวอย่าง ต้องการแยกชิ้นงานสีเขียวออกจากสายพานหลักที่ตำแหน่ง Station หมายเลข 2 จะมีกระบวนการดังนี้

  1. เขียนโปรแกรมอ่านค่า Sensor หมายเลข 2 ทุก ๆ 100 ms เพื่อตรวจสอบว่ามีชิ้นงานถูกลำเลียงมาถึงตำแหน่งที่กำหนดแล้วหรือไม่
  2. เมื่อ Sensor ตรวจพบชิ้นงาน ให้ทำการเขียนโปรแกรมอ่านค่า Sensor หมายเลข 10 เพื่อตรวจสอบสีของชิ้นงาน
  3. เมื่อค่าสีที่อ่านได้จาก Sensor หมายเลข 10 มีค่าเป็นสีเขียว ให้ทำการเขียนโปรแกรมสั่งให้ Actuator หมายเลข 10 ทำงานเพื่อผลักชิ้นงานออกจากสายพานหลัก

หมายเหตุ Vision System ให้ใช้ Sensor หมายเลข 10 (S10)

0

TSS ID

TeleSorting System – F2

ระบบจัดเรียงของระยะไกล ระบบที่ 2

ระบบจัดเรียงของระยะไกลระบบที่ 2 (TeleSorting System – F2) เป็นระบบที่สามารถจำแนกชิ้นงานด้วยประเภทวัสดุ โดย Sensor ของระบบนี้จะทำหน้าที่ตรวจจับประเภทวัสดุของชิ้นงาน ได้แก่ วัสดุที่เป็นโลหะและวัสดุที่เป็นอโลหะ เมื่อชิ้นงานเคลื่อนที่ไปตามสายพาน จะมี Sensor สำหรับตรวจจับชิ้นงานและ Actuator สำหรับผลักชิ้นงาน

1

TSS ID

Installation

การติดตั้ง API สำหรับใช้งาน TeleSorting System สามารถติดตั้งโดยการ Download ไฟล์ Zip และทำการ Extract ไปยัง Directory ใดก็ได้ที่ต้องการใช้งาน

API ประกอบไปด้วยไฟล์ จำนวน 2 ไฟล์ ได้แก่ setting.json สำหรับตั้งค่าการทำงานของ API และ tss api.exe สำหรับเปิดใช้งาน API

เริ่มการทำงานของ API

ให้ Double Click ที่ tss api.exe เพื่อเริ่มต้นการทำงาน

หากสามารถเริ่มต้นการทำงานด้วยวิธีข้างต้นให้ใช้วิธีเรียกใช้งานผ่าน Command Prompt ขั้นตอนดังนี้

  1. เปิด Command Prompt
  2. ใช้คำสั่ง cd <Path> แล้วกด Enter // <Path> หมายถึง Path ของ Directory ที่อยู่ของไฟล์ tss api.exe
  3. พิมพ์ใน Command Prompt ดังนี้ “tss api.exe” เพื่อเริ่มต้นการทำงาน
  4. เมื่อระบบปฏิบัติการขึ้นหน้าต่าง Windows Security Alert ให้เลือก Allow Access
  5. เมื่อสำเร็จจะขึ้น Connection Accepted.

หมายเหตุ

  1. ทุกครั้งที่ต้องการใช้ API จะต้องเปิดไฟล์นี้ทุกครั้ง
  2. ไม่สามารถเปิด API พร้อมกัน 2 ตัวในเครื่องเดียวกันได้
  3. เมื่ออยู่ใน Network เดียวกัน สามารถใช้งาน API ร่วมกันได้
  4. ไฟล์ จะมีให้ดาวน์โหลดสำหรับผู้ร่วมการเข้าแข่งขัน
  5. รองรับการใช้งานกับ Windows 10

ตัวอย่างการใช้งาน API ด้วยโปรแกรม Postman

การอ่านค่า Status ของ TeleSorting System

อ่านข้อมูลสถานะของ (Status) ระบบจัดเรียงของระยะไกลว่ามีสถานะพร้อมทำงานหรือไม่ โดยใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/TSS_ID/status
  • TSS_ID คือ หมายเลขระบบจัดเรียงของระยะไกลที่ต้องการอ่านข้อมูลสถานะ (0 หรือ 1)

API จะตอบกลับข้อมูล Status ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

{ “id” : ID , “value” : VALUE }
  • ID คือ หมายเลขระบบจัดเรียงของระยะไกล
  • VALUE คือ สถานะระบบจัดเรียงของระยะไกล มีค่า online หรือ offline

การอ่านค่า Latency ระหว่าง API และ TeleSorting System

การอ่านค่า Latency ระหว่าง API และ TeleSorting System โดยใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/TSS_ID/latency
  • TSS_ID คือ หมายเลขระบบจัดเรียงของระยะไกลที่ต้องการอ่านค่า (0 หรือ 1)

API จะตอบกลับข้อมูล Latency ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

{ “id” : ID , “value” : VALUE , “unit” : “millisecond”}
  • ID คือ หมายเลขระบบจัดเรียงของระยะไกล
  • VALUE คือ Latency ในระบบ เป็นตัวเลข (Integer)

Accessing Sensor

การอ่านข้อมูลจากเซนเซอร์ในระบบจัดเรียงของระยะไกล

อ่านข้อมูล Sensor จำนวน 1 ตัว

อ่านข้อมูล Sensor จำนวน 1 ตัว ที่ได้จากระบบจัดเรียงของระยะไกล โดยใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/TSS_ID/sensor/SS_ID
  • TSS_ID คือ หมายเลขระบบจัดเรียงของระยะไกลที่ต้องการอ่านค่า (0 หรือ 1)
  • SS_ID คือ หมายเลขของ Sensor ในระบบจัดเรียงของระยะไกล

API จะตอบกลับข้อมูล Sensor ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

{ “id” : ID , “type” : TYPE , “value” : VALUE }
  • ID คือ หมายเลข Sensor
  • TYPE คือ ประเภทของ Sensor
  • VALUE คือ ข้อมูลการตรวจจับชิ้นงานของ Sensor

หมายเหตุ หมายเลขของ Sensor (SS_ID) สามารถดูได้ตามรูปประกอบในหัวข้อ TeleSorting System – F1 และ TeleSorting System – F2

ตัวอย่างที่ 1

ต้องการอ่านค่า Sensor หมายเลข 5 ของระบบจัดเรียงของระยะไกลระบบที่ 1 ต้องใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/0/sensor/5

API จะตอบกลับข้อมูล Sensor ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

{ “id” : 5 , “type” : “Optical Proximity” , “value” : 0}

ตัวอย่างที่ 2

ต้องการอ่านค่า Sensor หมายเลข 10 (กล้องตรวจจับสี) ของระบบจัดเรียงของระยะไกลระบบที่ 1 ต้องใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/0/sensor/10

API จะตอบกลับข้อมูล Sensor ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

{ “id” : 10 , “type” : “Color” , “value” : “GREEN”}

อ่านข้อมูล Sensor ทั้งหมด

อ่านข้อมูล Sensor ทั้งหมดพร้อมกันที่ได้จากระบบจัดเรียงของระยะไกล โดยใช้ GET Method ด้วย URL ดังนี้

http://localhost/tss/TSS_ID/sensor
  • TSS_ID คือ หมายเลขระบบจัดเรียงของระยะไกลที่ต้องการอ่านค่า (0 หรือ 1)

API จะตอบกลับข้อมูล Sensor ทั้งหมด (Array) ของระบบจัดเรียงของระยะไกลในรูปแบบ JSON ดังนี้

[ { “id” : ID , “type” : TYPE , “value” : VALUE } , { “id” : ID , “type” : TYPE , “value” : VALUE } , … ]
  • ID คือ หมายเลข Sensor
  • TYPE คือ ประเภทของ Sensor
  • VALUE คือ ข้อมูลการตรวจจับชิ้นงานของ Sensor

Controlling Actuator

การสั่งงานอุปกรณ์ขับเคลื่อนในระบบจัดเรียงของระยะไกล

ควบคุมการทำงาน Actuator จำนวน 1 ตัว ที่อยู่ในระบบจัดเรียงของระยะไกล โดยใช้ POST Method ด้วย URL ดังนี้

http://localhost/tss/TSS_ID/actuator/AC_ID
  • TSS_ID คือ หมายเลขระบบจัดเรียงของระยะไกลที่ต้องการอ่านค่า (0 หรือ 1)
  • AC_ID คือ หมายเลขของ Actuator ในระบบจัดเรียงของระยะไกล

ข้อมูล (Body) ที่ต้องส่งเพื่อควบคุมการทำงาน Actuator จะอยู่ในรูปแบบ JSON ดังนี้

{ “action” : VALUE }
  • VALUE คือ คำสั่งควบคุม Actuator โดย 1 หมายถึง ดันก้านกระบอกลมออก (Extend) และ 0 หมายถึง ดึงก้านกระบอกลมกลับ (Retract)

หมายเหตุ สามารถศึกษาการควบคุม Actuator ได้ที่หัวข้อ ตัวอย่างการใช้งาน API ด้วยโปรแกรม Postman