DIVUS VISION API سافٹ ویئر
وضاحتیں
- پروڈکٹ: DIVUS VISION API
- ڈویلپر: DIVUS GmbH
- ورژن: 1.00 REV0 1 - 20240528
- مقام: Pillhof 51, Eppan (BZ), اٹلی
پروڈکٹ کی معلومات
DIVUS VISION API ایک سافٹ ویئر ٹول ہے جو DIVUS VISION سسٹم کے ساتھ انٹرفیس کرنے کے لیے ڈیزائن کیا گیا ہے۔ یہ صارفین کو MQTT پروٹوکول کا استعمال کرتے ہوئے سسٹم کے اندر مختلف عناصر تک رسائی اور کنٹرول کرنے کی اجازت دیتا ہے۔
اکثر پوچھے گئے سوالات
سوال: کیا میں پی سی یا آٹومیشن ٹیکنالوجی کی پیشگی معلومات کے بغیر DIVUS VISION API استعمال کر سکتا ہوں؟
A: دستی کو ان علاقوں میں سابقہ علم رکھنے والے صارفین کے لیے تیار کیا گیا ہے تاکہ API کے موثر استعمال کو یقینی بنایا جا سکے۔
عمومی معلومات
- DIVUS GmbH Pillhof 51 I-39057 Eppan (BZ) - اٹلی
آپریٹنگ ہدایات، دستورالعمل اور سافٹ ویئر کاپی رائٹ کے ذریعے محفوظ ہیں۔ جملہ حقوق محفوظ ہیں. نقل کرنے، نقل کرنے، ترجمہ کرنے، مکمل یا جزوی طور پر ترجمہ کرنے کی اجازت نہیں ہے۔ ایک استثناء کا اطلاق ذاتی استعمال کے لیے سافٹ ویئر کی بیک اپ کاپی بنانے پر ہوتا ہے۔
دستی بغیر اطلاع کے تبدیل کرنے کے تابع ہے۔ ہم اس بات کی ضمانت نہیں دے سکتے کہ اس دستاویز میں اور فراہم کردہ اسٹوریج میڈیا پر موجود ڈیٹا غلطیوں سے پاک اور درست ہے۔ بہتری کے لیے تجاویز اور غلطیوں پر اشارے ہمیشہ خوش آئند ہیں۔ معاہدوں کا اطلاق اس دستور العمل کے مخصوص ضمیموں پر بھی ہوتا ہے۔ اس دستاویز میں موجود عہدہ ایسے ٹریڈ مارک ہو سکتے ہیں جن کا استعمال تیسرے فریق اپنے مقاصد کے لیے ان کے مالکان کے حقوق کی خلاف ورزی کر سکتے ہیں۔ صارف کی ہدایات: براہ کرم اس دستی کو پہلی بار استعمال کرنے سے پہلے پڑھیں اور اسے مستقبل میں حوالہ کے لیے محفوظ جگہ پر رکھیں۔ ٹارگٹ گروپ: دستی پی سی اور آٹومیشن ٹیکنالوجی کی سابقہ معلومات رکھنے والے صارفین کے لیے لکھی گئی ہے۔
پریزنٹیشن کنونشنز
تعارف
عمومی تعارف
یہ دستی VISION API (ایپلی کیشن پروگرامنگ انٹرفیس) کی وضاحت کرتا ہے - ایک انٹرفیس جس کے ذریعے VISION کو بیرونی نظاموں سے ایڈریس اور کنٹرول کیا جا سکتا ہے۔
عملی اصطلاحات میں، اس کا مطلب یہ ہے کہ آپ سسٹم استعمال کر سکتے ہیں جیسے
- ایم کیو ٹی ٹی ایکسپلورر (https://www.microsoft.com/store/… – جانچ کے لیے)
- ہوم اسسٹنٹ (https://www.home-assistant.io/) یا
- نوڈ-ریڈ (https://nodered.org/)
VISION کے زیر انتظام عناصر کو کنٹرول کرنے یا ان کی حیثیت کو پڑھنے کے لیے۔ رسائی اور مواصلت MQTT پروٹوکول کے ذریعے ہوتی ہے، جو انفرادی افعال یا افعال کے سیٹ کو حل کرنے یا ان میں ہونے والی تبدیلیوں کے بارے میں مطلع کرنے کے لیے نام نہاد عنوانات کا استعمال کرتا ہے۔ اس مقصد کے لیے ایک MQTT سرور (بروکر) استعمال کیا جاتا ہے، جو سیکیورٹی اور شرکاء کو پیغامات کی تقسیم/تقسیم کو سنبھالتا ہے۔ اس صورت میں، MQTT سرور براہ راست DIVUS KNX IQ پر واقع ہے اور خاص طور پر اس مقصد کے لیے ترتیب دیا گیا ہے۔ اگرچہ VISION API کو پروگرامنگ کے علم کے بغیر بھی استعمال کیا جا سکتا ہے، لیکن یہ فعالیت اعلی درجے کے صارفین کے لیے موزوں ہے۔
ضروریات
جیسا کہ VISION مینوئل میں بیان کیا گیا ہے، API صارف کو پہلے ڈیفالٹ کے طور پر فعال ہونا چاہیے تاکہ اسے استعمال کرنے کے قابل ہو سکے API رسائی صرف Api صارفین کے تصدیقی ڈیٹا کا استعمال کرتے ہوئے کام کرتی ہے۔ جہاں تک صارف کے حقوق کا تعلق ہے، اس فعالیت کے لیے ایکٹیویشن کو پھر تمام یا انفرادی عناصر پر ترتیب دیا جا سکتا ہے۔ دیکھیں باب 0۔ بلاشبہ، آپ کو ایک VISION پروجیکٹ کی بھی ضرورت ہے جس میں وہ عناصر جنہیں آپ باہر سے کنٹرول کرنا چاہتے ہیں مکمل طور پر کنفیگر ہوں اور ان سے کنکشن کا کامیابی سے تجربہ کیا گیا ہو۔ API کے ذریعے انفرادی عناصر کو ایڈریس کرنے کے قابل ہونے کے لیے، ان کی عنصر ID کا علم ہونا ضروری ہے: یہ عنصر کی ترتیبات کے فارم کے نیچے ظاہر ہوتا ہے۔
سیکورٹی
سیکورٹی وجوہات کی بنا پر، API تک رسائی صرف مقامی طور پر ممکن ہے (یعنی کلاؤڈ کے ذریعے نہیں)۔ API رسائی کو چالو کرتے وقت سیکیورٹی رسک اس لیے کم ہے۔ اس کے باوجود، سیکورٹی سے متعلقہ عناصر کو فعال یا واضح طور پر API تک رسائی سے انکار نہیں کیا جانا چاہیے۔
MQTT اور اس کی شرائط - مختصر وضاحت
MQTT میں مرکزی انتظام اور تمام پیغامات کی تقسیم کا کردار بروکر کا ہے۔ اگرچہ MQTT سرور اور MQTT بروکر مترادف نہیں ہیں (سرور اس کردار کے لیے ایک وسیع تر اصطلاح ہے جسے MQTT کلائنٹس بھی ادا کر سکتے ہیں)، بروکر کا مطلب ہمیشہ اس مینول میں ہوتا ہے جب MQTT سرور کا ذکر ہوتا ہے۔ DIVUS KNX IQ خود اس مینول کے تناظر میں MQTT بروکر/MQTT سرور کا کردار ادا کرتا ہے۔
ایک MQTT سرور نام نہاد عنوانات کا استعمال کرتا ہے: ایک درجہ بندی کا ڈھانچہ جس کے ساتھ ڈیٹا کی درجہ بندی، نظم اور شائع کیا جاتا ہے۔
اشاعت کا بنیادی مقصد عنوانات کے ذریعے دیگر شرکاء کو ڈیٹا دستیاب کرنا ہے۔ اگر آپ کسی قدر کو تبدیل کرنا چاہتے ہیں، تو آپ پبلشنگ ایکشن کا استعمال کرتے ہوئے مطلوبہ قدر کی تبدیلی کے ساتھ مطلوبہ موضوع پر لکھتے ہیں۔ ٹارگٹ ڈیوائس یا MQTT سرور مطلوبہ تبدیلی کو پڑھتا ہے جو اس پر اثر انداز ہوتا ہے اور اس کے مطابق اسے اپناتا ہے۔ یہ چیک کرنے کے لیے کہ تبدیلی لاگو ہو گئی ہے، آپ سبسکرائب شدہ ریئل ٹائم ٹاپک میں دیکھ سکتے ہیں کہ آیا وہاں تبدیلی کی عکاسی ہوتی ہے - اگر سب کچھ ٹھیک ہو گیا ہے۔
کلائنٹ ان موضوعات کا انتخاب کرتے ہیں جو ان کی دلچسپی رکھتے ہیں: اسے سبسکرائب کرنا کہتے ہیں۔ ہر بار جب کسی موضوع میں/نیچے کوئی قدر تبدیل ہوتی ہے، سبھی سبسکرائب شدہ کلائنٹس کو مطلع کیا جاتا ہے – یعنی واضح طور پر یہ پوچھے بغیر کہ آیا کچھ تبدیل ہوا ہے یا موجودہ قدر کیا ہے۔
آپ کسی موضوع میں client_id نامی کوئی بھی منفرد سٹرنگ درج کرکے MQTT سرور کے ساتھ ایک علیحدہ مواصلاتی چینل کھول سکتے ہیں (یا پتہ)۔ کلائنٹ_آئی ڈی کو اقدار پر کارروائی کرنے کے لیے موضوع میں استعمال کیا جانا چاہیے۔ یہ ہر تبدیلی کی اصلیت کی نشاندہی کرنے میں کام کرتا ہے، کسی بھی غلطی سے مدد کرتا ہے اور دوسرے کلائنٹس کو متاثر نہیں کرتا، کیونکہ سرور سے متعلقہ جوابات، بشمول کسی بھی ایرر کوڈز اور پیغامات، بھی صرف اسی کلائنٹ_آئی ڈی کے ساتھ موضوع تک پہنچتے ہیں (اور اس طرح صرف وہ کلائنٹ)۔ client_id ایک منفرد کریکٹر سٹرنگ ہے جو 0-9، az، AZ، "-"، "_" حروف کے کسی بھی مجموعہ پر مشتمل ہے۔
عام طور پر، DIVUS KNX IQ کے MQTT سرور کے سبسکرائب کے عنوانات کلیدی الفاظ کی حیثیت پر مشتمل ہوتے ہیں، جب کہ اشاعت کے عنوانات مطلوبہ الفاظ کی درخواست پر مشتمل ہوتے ہیں۔ اسٹیٹس کے ساتھ جیسے ہی کوئی بیرونی قدر میں تبدیلی ہوتی ہے یا جیسے ہی کلائنٹ کی طرف سے کسی اشاعت کے ذریعے قدر میں تبدیلی کی درخواست کی جاتی ہے اور کامیابی کے ساتھ لاگو ہوتی ہے تو وہ خود بخود اپ ڈیٹ ہو جاتے ہیں۔ اشاعت کے لیے ان کو مزید قسم (درخواست/)گیٹ اور قسم (درخواست/) سیٹ میں تقسیم کیا گیا ہے۔
قدر میں تبدیلی اور دیگر اختیاری پیرامیٹرز نام نہاد پے لوڈ کے ساتھ موضوع میں شامل کیے جاتے ہیں۔ انفرادی عناصر کے پیرامیٹرز (عنصر کی شناخت، نام، قسم، افعال)
MQTT اور کلاسک کلائنٹ سرور ماڈل کے درمیان بنیادی فرق، جہاں کلائنٹ درخواست کرتا ہے اور پھر ڈیٹا کو تبدیل کرتا ہے، سبسکرائب اور شائع کرنے کے تصورات پر مرکوز ہے۔ شرکاء ڈیٹا شائع کر سکتے ہیں، اسے دوسروں کے لیے دستیاب کر سکتے ہیں، جو اگر دلچسپی رکھتے ہیں تو اسے سبسکرائب کر سکتے ہیں۔ یہ فن تعمیر ڈیٹا کے تبادلے کو کم سے کم کرنے اور تمام دلچسپی رکھنے والی جماعتوں کو تازہ ترین رکھنے کو ممکن بناتا ہے۔ یہاں تفصیلات کے بارے میں مزید: اور خصوصی پیرامیٹرز (uuid، فلٹر) یہاں استعمال کیے جائیں گے۔ اگرچہ کئی اختیارات ہیں، پے لوڈ کو اس دستی میں JSON کے طور پر فارمیٹ کیا گیا ہے۔ JSON کسی بھی ڈھانچے کے ڈیٹا کی نمائندگی کرنے کے لیے بریکٹ اور کوما کا استعمال کرتا ہے اور اس طرح منتقل کیے جانے والے ڈیٹا پیکٹ کے سائز کو کم کرتا ہے۔ پے لوڈز کے بارے میں مزید تفصیلات دستی میں بعد میں مل سکتی ہیں۔
خاص مقاصد کے لیے، فنکشن کی قسم کے مطابق فلٹر کرنا ممکن ہے، مثلاً صرف آن/آف یعنی 1 بٹ سوئچز کو ایڈریس کرنا۔ پے لوڈ میں فلٹر پیرامیٹر اس مقصد کے لیے استعمال کیا جاتا ہے۔ فلٹرنگ فی الحال صرف فنکشن کی قسم سے ممکن ہے۔
انفرادی عناصر کو ایڈریس کرنے کے قابل ہونے کے لیے، ان کے عنصر کی شناخت درکار ہے۔ یہ عنصر کی خصوصیات کے مینو میں VISION میں پایا جا سکتا ہے یا اس ڈیٹا سے بھی براہ راست پڑھا جا سکتا ہے جو MQTT ایکسپلورر کے عام سبسکرائب میں ہر دستیاب عنصر کے سامنے دکھائے جاتے ہیں (وہاں عناصر کو عنصر ID کے ذریعہ حروف تہجی کے مطابق درج کیا جاتا ہے)۔
API رسائی کے لیے کنفیگریشن
API صارف کی رسائی کے لیے وژن کو ترتیب دینا
VISION میں بطور ایڈمنسٹریٹر، کنفیگریشن - یوزر/API ایکسیس مینجمنٹ پر جائیں، Users/API رسائی پر کلک کریں اور ایڈیٹنگ ونڈو کو کھولنے کے لیے API یوزر (یا دبائیں اور ہولڈ) پر دائیں کلک کریں۔ وہاں آپ کو یہ پیرامیٹرز اور ڈیٹا مل جائے گا۔
- فعال کریں (چیک باکس)
- صارف سب سے پہلے یہاں فعال ہے۔ ڈیفالٹ غیر فعال ہے۔
- صارف نام
- API کے ذریعے رسائی کے لیے اس سٹرنگ کی ضرورت ہے - اسے یہاں سے کاپی کریں۔
- پاس ورڈ
- API کے ذریعے رسائی کے لیے اس سٹرنگ کی ضرورت ہے - اسے یہاں سے کاپی کریں۔
- اجازتیں
- VISION عناصر کی قدروں کو پڑھنے اور لکھنے کے پہلے سے طے شدہ حقوق یہاں بیان کیے جا سکتے ہیں، یعنی جو کچھ یہاں بیان کیا گیا ہے وہ تمام موجودہ اور مستقبل کے عناصر پر لاگو ہوتا ہے۔ اگر آپ صرف انفرادی عناصر تک رسائی کی اجازت دینا چاہتے ہیں، تو آپ کو ان ڈیفالٹ حقوق کو تبدیل نہیں کرنا چاہیے۔
انفرادی عناصر پر اجازت
یہ تجویز کیا جاتا ہے کہ آپ API کو پورے پروجیکٹ تک رسائی نہ دیں، بلکہ صرف مطلوبہ عناصر تک۔ مندرجہ ذیل کے طور پر آگے بڑھیں
- VISION میں بطور ایڈمنسٹریٹر لاگ ان کریں۔
- مطلوبہ عنصر کو منتخب کریں اور اس کی ترتیبات کا مینو کھولیں (دائیں کلک کریں یا دبائے رکھیں، پھر ترتیبات)
- مینو انٹری جنرل - پرمیشنز کے تحت، "ڈیفالٹ اجازتوں کو اوور رائڈ کریں" کو چالو کریں اور پھر ذیلی آئٹم پرمیشنز پر جائیں، جو اجازتوں کا میٹرکس دکھاتا ہے۔
- یہاں کنٹرول کی اجازت کو چالو کریں، جو اس کو بھی قابل بناتا ہے۔ view براہ راست اجازت. اگر آپ صرف API رسائی کے ذریعے ڈیٹا پڑھنا چاہتے ہیں، تو اسے فعال کرنے کے لیے کافی ہے۔ view اجازت
- ان تمام عناصر کے لیے ایک ہی طریقہ کار کو دہرائیں جن تک آپ رسائی حاصل کرنا چاہتے ہیں۔
MQTT کے ذریعے کنکشن
تعارف
بطور سابقampلی، ہم DIVUS KNX IQ کے MQTT API کے ذریعے ایک نسبتاً آسان، مفت سافٹ ویئر کے ذریعے رسائی کا مظاہرہ کریں گے جسے MQTT ایکسپلورر کہا جاتا ہے (دیکھیں باب 1.1)، جو ونڈوز، میک اور لینکس کے لیے دستیاب ہے۔ MQTT کے ساتھ ایک بنیادی علم اور تجربہ مضمر ہے۔
کنکشن کے لیے ڈیٹا درکار ہے۔
جیسا کہ پہلے ذکر کیا گیا ہے (سیکشن 2.1 دیکھیں)، API صارف کا صارف نام اور پاس ورڈ درکار ہے۔ یہاں ایک اوور ہے۔view کنکشن قائم ہونے سے پہلے جمع کیے جانے والے تمام ڈیٹا میں سے:
- صارف نام API صارف کے تفصیلی صفحہ پر پڑھیں
- API صارف کے تفصیلی صفحہ پر پاس ورڈ پڑھیں
- آئی پی ایڈریس جنرل - نیٹ ورک - ایتھرنیٹ (یا سنکرونائزر کے ذریعے) کے تحت لانچر کی ترتیبات میں پڑھیں
- پورٹ 8884 (یہ بندرگاہ اس مقصد کے لیے مخصوص ہے)
MQTT ایکسپلورر اور جنرل سبسکرائب کے ساتھ پہلا رابطہ
عام طور پر، MQTT سبسکرائب کرنے اور شائع کرنے کی سرگرمیوں کے درمیان فرق کرتا ہے۔ MQTT ایکسپلورر پہلا کنکشن ہونے پر تمام دستیاب عنوانات (موضوع #) کو خود بخود سبسکرائب کر کے اسے آسان بنا دیتا ہے۔ نتیجے کے طور پر، وہ درخت جو تمام دستیاب عناصر کی طرف لے جاتا ہے (یعنی API صارف تک رسائی دی گئی) کامیاب کنکشن کے بعد براہ راست MQTT ایکسپلورر ونڈو کے بائیں ہاتھ کے علاقے میں دیکھا جا سکتا ہے۔ مزید سبسکرائب عنوانات درج کرنے کے لیے یا # کو مزید مخصوص عنوان سے بدلنے کے لیے، کنکشن ونڈو میں ایڈوانسڈ پر جائیں۔ اوپری دائیں طرف دکھایا گیا موضوع کچھ اس طرح نظر آتا ہے:
جہاں 7f4x0607849x444xxx256573x3x9x983 API کا صارف نام ہے اور objects_list تمام دستیاب عناصر پر مشتمل ہے۔ اس موضوع کو ہمیشہ اپ ٹو ڈیٹ رکھا جاتا ہے یعنی کوئی بھی قدر میں تبدیلی اصل وقت میں ظاہر ہوتی ہے۔ اگر آپ صرف انفرادی عناصر کو سبسکرائب کرنا چاہتے ہیں، تو مطلوبہ عنصر کی عنصر ID کو objects_list/ کے بعد درج کریں۔
نوٹ: اس قسم کا سبسکرائب تقریباً KNX فیڈ بیک ایڈریس کے پیچھے منطق سے مطابقت رکھتا ہے۔ یہ عناصر کی موجودہ حیثیت کو ظاہر کرتا ہے اور یہ جانچنے کے لیے استعمال کیا جا سکتا ہے کہ آیا مطلوبہ تبدیلیاں کامیابی کے ساتھ لاگو ہو گئی ہیں۔ اگر آپ صرف ڈیٹا پڑھنا چاہتے ہیں لیکن اسے تبدیل نہیں کرنا چاہتے ہیں تو اس قسم کا سبسکرائب کافی ہے۔
JSON اشارے میں ایک سادہ عنصر کچھ اس طرح نظر آتا ہے۔
نوٹ: تمام اقدار میں اوپر دکھایا گیا نحو ہوتا ہے جیسے کہ سبسکرائب کرنے والے عنوانات کے آؤٹ پٹ کے طور پر { “value”: “1” }، جب کہ ویلیو کو براہ راست پے لوڈ میں لکھا جاتا ہے تاکہ کسی قدر کو تبدیل کیا جا سکے (یعنی عنوانات شائع کرنے کے لیے) – بریکٹ اور "قدر" کو چھوڑ دیا گیا ہے جیسے "آن آف": "1"۔
اعلی درجے کی کمانڈز
تعارف
عمومی طور پر 3 قسم کے موضوعات ہیں:
- دستیاب عناصر کو دیکھنے اور ریئل ٹائم ویلیو تبدیلیاں حاصل کرنے کے لیے عنوان (موضوعات) کو سبسکرائب کریں۔
- کے جوابات حاصل کرنے کے لیے عنوان (موضوعات) کو سبسکرائب کریںگاہکوں ) درخواستیں شائع کریں۔
- عناصر کو ان کی اقدار کے ساتھ حاصل کرنے یا سیٹ کرنے کے لیے عنوان (موضوعات) شائع کریں۔
ہم بعد میں یہاں دکھائے گئے نمبروں کا استعمال کرتے ہوئے ان اقسام کا حوالہ دیں گے (مثلاً قسم 1، 2، 3 کے عنوانات)۔ مزید تفصیلات درج ذیل حصوں اور باب میں۔ 4.2
دستیاب عناصر کو دیکھنے اور ریئل ٹائم ویلیو چینجز حاصل کرنے کے لیے عنوانات کو سبسکرائب کریں
یہ پہلے بیان ہو چکے ہیں۔
کلائنٹ کی اشاعت کی درخواستوں کے جوابات حاصل کرنے کے لیے عنوانات کو سبسکرائب کریں
اس قسم کے موضوعات اختیاری ہیں۔ اس کی اجازت دیتا ہے۔
- صوابدیدی client_id استعمال کرکے MQTT سرور کے ساتھ ایک منفرد مواصلاتی چینل کھولیں۔ اس کے بارے میں مزید باب میں۔ 4.2.2
- متعلقہ سبسکرائب موضوع پر درخواستوں کی اشاعت کا نتیجہ حاصل کریں: ایرر کوڈ اور پیغام کے ساتھ کامیابی یا ناکامی۔
پبلش کمانڈز حاصل کرنے یا سیٹ کرنے کے لیے جوابات حاصل کرنے کے لیے مختلف عنوانات ہیں۔ میں متعلقہ فرق
ایک بار جب آپ اپنے سسٹم کے لیے مطلوبہ عنوانات حاصل کر لیتے ہیں، تو آپ اس مرحلے کو ہٹانے اور براہ راست شائع کرنے والے عنوانات کو استعمال کرنے کا فیصلہ کر سکتے ہیں۔
عناصر کو ان کی اقدار کے ساتھ حاصل کرنے یا سیٹ کرنے کے لیے عنوانات شائع کریں
یہ عنوانات سبسکرائب کرنے کے لیے جیسا راستہ استعمال کرتے ہیں - سبسکرائب کرنے کے لیے استعمال ہونے والے "اسٹیٹس" کی جگہ صرف تبدیلی لفظ "درخواست" ہے۔ موضوع کے مکمل راستے بعد میں باب میں دکھائے گئے ہیں۔ 4.2.2\ A get topic MQTT سرور کے عناصر اور اقدار کو پڑھنے کی درخواست کرے گا۔ پے لوڈ کو عناصر کے فنکشن کی قسم کی بنیاد پر فلٹر کرنے کے لیے استعمال کیا جا سکتا ہے۔ ایک سیٹ ٹاپک کسی عنصر کے کچھ حصوں کو تبدیل کرنے کی درخواست کرے گا، جیسا کہ اس کے پے لوڈ میں تفصیل ہے۔
کمانڈز اور متعلقہ جوابات کے لیے پریفکس
مختصر وضاحت
تمام کمانڈز جو MQTT سرور کو بھیجے جاتے ہیں ان کا ایک مشترکہ ابتدائی حصہ ہوتا ہے، یعنی:
تفصیلی وضاحت
اصل وقت کے عنوانات (قسم 1) میں عمومی سابقہ ہوگا (اوپر دیکھیں) پھر اس کے بعد
or
سیٹ کمانڈز کے لیے، پے لوڈ واضح طور پر مرکزی کردار ادا کرتا ہے کیونکہ اس میں مطلوبہ تبدیلیاں ہوں گی (یعنی عنصر کے افعال کے لیے تبدیل شدہ اقدار)۔ ایک انتباہ: اپنے ٹائپ 3 کمانڈز میں کبھی بھی برقرار رکھنے کا اختیار استعمال نہ کریں کیونکہ یہ KNX کی طرف مسائل کا سبب بن سکتا ہے۔
EXAMPLE: ایک عنصر کی قدروں کو تبدیل کرنے کے لیے شائع کریں
سب سے آسان معاملہ یہ ہے کہ عام سبسکرائب کے ذریعہ دکھائے گئے عناصر میں سے کسی ایک کی قدر کو تبدیل کرنا چاہتے ہیں۔
عام طور پر، MQTT کے ذریعے VISION کے فنکشن کو تبدیل کرنا/سوئچ کرنا 3 مراحل پر مشتمل ہے، جن میں سے سبھی قطعی طور پر ضروری نہیں ہیں، لیکن اس کے باوجود ہم ان کو جیسا کہ بیان کیا گیا ہے اسے انجام دینے کی سفارش کرتے ہیں۔
- وہ موضوع جس میں فنکشن شامل ہے جس میں ہم ترمیم کرنا چاہتے ہیں اپنی مرضی کے مطابق client_id کا استعمال کرکے سبسکرائب کیا جاتا ہے۔
- ترمیم کا موضوع 1 میں منتخب کردہ client_id کا استعمال کرتے ہوئے مطلوبہ تبدیلیوں کے ساتھ پے لوڈ کے ساتھ شائع کیا جاتا ہے۔
- چیک کرنے کے لیے، آپ پھر عنوان (1.) میں جواب دیکھ سکتے ہیں - یعنی آیا (2.) نے کام کیا یا نہیں
- عام سبسکرائب میں، جہاں تبدیلیاں ہونے پر تمام اقدار کو اپ ڈیٹ کر دیا جاتا ہے، اگر سب کچھ ٹھیک ہو گیا ہے تو آپ مطلوبہ قدر میں تبدیلی دیکھ سکتے ہیں۔
ایسا کرنے کے اقدامات یہ ہیں:
- ایک client_id منتخب کریں جیسے "Divus" اور اسے API صارف نام کے بعد راستے میں داخل کریں۔
MQTT سرور کے ساتھ آپ کے اپنے مواصلاتی چینل کو سبسکرائب کرنے کا یہ مکمل موضوع ہے۔ یہ سرور کو بتاتا ہے جہاں آپ ان تبدیلیوں کے جوابات کی توقع کرتے ہیں جو آپ بھیجنا چاہتے ہیں۔ اسٹیٹس/سیٹ حصے پر غور کریں جو a کی وضاحت کرتا ہے۔ کہ یہ سبسکرائب کا موضوع ہے اور ب۔ کہ اسے ٹائپ کمانڈ سیٹ کرنے کے جواب ملیں گے۔ - اشاعت کا موضوع ایک جیسا ہوگا سوائے اسٹیٹس کی درخواست کے مطلوبہ الفاظ کو تبدیل کرنے کے
- تبدیلی میں کیا ہونا چاہیے وہ پے لوڈ میں لکھا ہوا ہے۔ یہاں کچھ سابق ہیں۔amples
- ایک عنصر کو بند کرنا جس میں آن/آف فنکشن (1 بٹ):
- ایسے عنصر کو آن کرنا جس میں آن/آف فنکشن (1 بٹ) ہو۔ اس کے علاوہ، اگر ایک ہی کلائنٹ سے اس طرح کی کئی کمانڈز شروع کی جاتی ہیں، تو uuid پیرامیٹر ("منفرد ID"، عام طور پر 128 بٹ سٹرنگ ہے جسے 8-4-4-4-12 ہندسوں ہیکس کے طور پر فارمیٹ کیا جاتا ہے) کو تفویض کرنے کے لیے استعمال کیا جا سکتا ہے۔ متعلقہ استفسار کا جواب، جیسا کہ یہ پیرامیٹر - اگر استفسار میں موجود ہے - جواب میں بھی پایا جا سکتا ہے۔
- سوئچ آن کرنا اور مدھم کی چمک کو 50% پر سیٹ کرنا
- اوپر دکھائے گئے اور سبسکرائب کیے گئے عنوان کا جواب (اس کا پے لوڈ، بالکل درست ہونا) تو، سابق کے لیےample
مندرجہ بالا جواب ایک سابق ہےample درست پے لوڈ کی صورت میں، حالانکہ عنصر میں کوئی مدھم کام نہیں ہوتا ہے۔ اگر پے لوڈ کی صحیح تشریح نہ کرنے کی وجہ سے زیادہ سنگین مسائل ہیں، تو جواب اس طرح نظر آئے گا (مثال کے طور پر):
ایرر کوڈز اور میسجز کی وضاحت کے لیے لیکن عام طور پر، جیسے HTTP کے لیے، 200 کوڈز مثبت جوابات ہیں جبکہ 400 منفی ہیں۔
- ایک عنصر کو بند کرنا جس میں آن/آف فنکشن (1 بٹ):
EXAMPLE: متعدد عناصر کی اقدار کو تبدیل کرنے کے لیے شائع کریں۔
طریقہ کار ایک عنصر کو تبدیل کرنے سے پہلے دکھائے گئے طریقہ سے ملتا جلتا ہے۔ فرق یہ ہے کہ آپ عنوانات سے element_id کو خارج کرتے ہیں اور پھر پے لوڈ کے اندر موجود ڈیٹا کے سامنے عنصر_ids کے سیٹ کی نشاندہی کرتے ہیں۔ ذیل میں نحو اور ساخت دیکھیں۔
سوالات میں فنکشن ٹائپ کے لحاظ سے فلٹر کریں۔
پے لوڈ میں فلٹرز کا پیرامیٹر کسی عنصر کے صرف مطلوبہ فنکشن کو ایڈریس کرنے کی اجازت دیتا ہے۔ کسی سوئچ یا ڈیمر کے آن/آف فنکشن کو "آن آف" کہا جاتا ہے، مثال کے طور پرample، اور متعلقہ فلٹر کی وضاحت اس طرح کی گئی ہے:
جواب تو اس طرح لگتا ہے، سابق کے لیےample
مربع بریکٹ اشارہ کرتا ہے کہ آپ کئی فنکشنز سے بھی فلٹر کر سکتے ہیں، جیسے
اس طرح کے جواب کی طرف جاتا ہے:
اپینڈکس
غلطی والے کوڈز
MQTT کمیونیکیشن میں خرابیوں کا نتیجہ عددی کوڈ میں ہوتا ہے۔ مندرجہ ذیل جدول اسے توڑنے میں مدد کرتا ہے۔
پے لوڈ کے پیرامیٹرز
پے لوڈ سیاق و سباق کے لحاظ سے مختلف پیرامیٹرز کی حمایت کرتا ہے۔ مندرجہ ذیل جدول سے پتہ چلتا ہے کہ کون سے پیرامیٹرز کن عنوانات میں ہوسکتے ہیں۔
ورژن نوٹس
- ورژن 1.00
خبریں:
• پہلی اشاعت
دستاویزات / وسائل
 |
DIVUS VISION API سافٹ ویئر [پی ڈی ایف] یوزر مینوئل VISION API سافٹ ویئر، API سافٹ ویئر، سافٹ ویئر |
 |
DIVUS Vision API سافٹ ویئر [پی ڈی ایف] یوزر گائیڈ وژن API سافٹ ویئر، وژن، API سافٹ ویئر، سافٹ ویئر |