Api دریافت تمامی ابزارهای یک پروژه

دریافت تمام ابزارهای موجود در آن پروژه است که اطلاعات لازم را به شما ارائه می دهیم تا بتوانید اقدامات متفاوتی را انجام دهید.

url : https://app.airngin.com/Api/v1.0/Api/v1.0/Project/GetAllDeviceProjectForDevice

token : در query string به شما داده می شود باید در header پاس داده شود. مثال : bearer token

projectId : projectId در query string به شما داده می شود و باید به سمت سرور ارسال شود.

مقداری که به شما بازگردانده می شود:

{
    "isSuccess": true,
    "message": "{\"id\":8031001,\"Value\":{\"DefaultMessage\":\"عملیات با موفقیت انجام شد.\",\"ListOfMessages\":[{\"Lang\":\"fa\",\"Message\":\"عملیات با موفقیت انجام شد.\"}]}}",
    "returnType": 0,
    "requestId": null,
    "data": [
      {
        
        /* ای دی مکان می باشد که می توانید ابزارها را برای نمایش دادن 
         با کمک اتاق ها فیلتر نمایید
         */
        "placeId": "3526dd18-60e5-446c-94bf-qy3er3cc8d21",  
        // نام مکان (اتاق ها)
        "placeName": "سالن",
        // ای دی دستورات شما که در پنل در قسمت دستورات تعریف کرده اید نیاز است به سمت سرور ارسال شود.
        "operationId": "cty189b4-6775-49a2-990f-43b1182aec33",
        // نام دستورات شما که در پنل تعریف کرده اید
        "operationName": "ch1",
        // نوع ابزار را مشخص می نماید که می توانید از طریق جدول ارایه شده آن ها را متناسب با نیاز خود فیلتر نمایید به طور مثال فقط سنسورهای دما را نمایش دهید
        "uiTypeCode": "1",
        // سریال ابزار شما می باشد
        "deviceSerial": "AIRN026398U3Y2",
        // نام ابزار شما می باشد
        "deviceName": "لوستر",
        // آی دی ابزار می باشد
        "deviceId": "406f878b-6388-49aa-ac48-0a551c1214b1",
        // لیست فرمان های  مربوط به این دستور می باشد
        "operationCommands": [
          {
            // نام فرمان
            "name": "روشن",
            /*
                false : اگر این مقدار باشد جز دستورات اصلی کنترل آن ابزار است
                true : اگر این مقدار باشد جزو دستورا آپشنال می باشد
            */
            "isOption": false,
            /*
            مقدار این دستور در فایل js شما می باشد.
            */
            "command": "on",
            //  اطلاعات بیشتر
            "details": null,
            /*
            مقدار سیستمی نرم افزار می باشد که در نرم افزارهای موبایل ما این مقدار را می شناسیم و به سمت سرور و فایل های آنالیز شما روانه می نماییم
            */
            "appValue": "on"
          },
          {
            "name": "خاموش",
            "isOption": false,
            "command": "off",
            "details": null,
            "appValue": "off"
          }
        ]
      },
      {
        "placeId": "3526dd18-60e5-446c-94bf-qy3er3cc8d21",
        "placeName": "سالن",
        "operationId": "b06addfd-70d3-4b2f-acd5-c74e62dbf7b8",
        "operationName": "sensorTemp",
        "uiTypeCode": "20",
        "deviceSerial": "AIRN0009355096",
        "deviceName": "سنسور دمای سالن",
        "deviceId": "b619f446-5383-42ca-9105-30de4a29b1d5",
        "operationCommands": []
      },
      {
        "placeId": "55226d18-60d5-446c-94bf-ad3ff3cc8d21",
        "placeName": "سالن",
        "operationId": "7cd825e9-f207-45b5-8b9f-fd157408f77f",
        "operationName": "ch2",
        "uiTypeCode": "1",
        "deviceSerial": "AIRN026398U3Y2",
        "deviceName": "چراغ روشنایی",
        "deviceId": "1db269c4-4cb5-4fee-892c-54e795ea93be",
        "operationCommands": [
          {
            "name": "خاموش",
            "isOption": false,
            "command": "off",
            "details": null,
            "appValue": "off"
          },
          {
            "name": "روشن",
            "isOption": false,
            "command": "on",
            "details": null,
            "appValue": "on"
          }
        ]
      },
    
      {
        "placeId": "55226d18-60d5-446c-94bf-ad3ff3cc8d21",
        "placeName": "سالن",
        "operationId": "6ff4ef2a-6a9e-4e47-9d53-5633d037bed7",
        "operationName": "سنسور دما",
        "uiTypeCode": "20",
        "deviceSerial": "AIRN0009355096",
        "deviceName": null,
        "deviceId": "1398076f-2fd2-4828-8eb7-642f633d38c1",
        "operationCommands": []
      },
      
    ]
  }

نکته : اگر متنهای فارسی باکس بالا برای شما ناخوانا است تمامی متن را کپی نمایید و در یک paste ، notepad کنید.

شاید سوال کنید این اطلاعات در چه زمان هایی برای شما کارایی دارد.

ابتدا شما به تمام ابزارها دسترسی دارید.

یک گزینه به نام uiTypeCode برای هر ابزار موجود است که به واسطه آن متوجه می شوید ابزار از کدام نوع است.

مشاهده لیست uiTypeCode

کد نمونه فیلتر هر کدام از ابزارها در JQUERY و نمایش آن در یک DROPDOWN در فایل های نمونه آورده شده است.

خوب حالا این موارد در کجا برای شما قابل استفاده است؟

در اینجا صرفا چند مثال ساده می زنیم تا دیدیگاه شما نسبت به نحوه استفاده از این داده ها روشن تر شود.

مثال یک: شما یک رله برد دارید می خواهید آن را به یک سنسور متصل نمایید تا دمای آن را دریافت کنید. برای آنکه بدانید کدام سنسور مد نظر کلاینت می باشد و اطلاعات آن را دریافت کنید نیاز است در صفحه تنظیمات تمامی سنسورهایی که مربوط به دما است را به کاربر نمایش دهید تا بتوانند بدون مشکل آن سنسور را انتخاب نمایند.

مثال دوم : ممکن است شما تولید کننده تاچ اسکرین باشید، بخواهید مقادیر سنسورها را بر روی خود نشان دهید با راحتی می توانید توسط این کدها متوجه شوید کدام ها سنسور هستند و از چه دسته ای هستند.

مثال سوم : شاید شما بخواهید یک ابزار را از طریق یک ابزار دیگر کنترل نمایید کافیست ابزار ها لود نمایید تا کاربر به راحتی بتواند انتخاب کند کدام ابزار را می خواهد توسط ابزار دیگر کنترل نماید.

تمام این موارد بستگی به خلاقیت و نحوه دیدگاه شما دارد. توصیه می شود تمام مستندات آموزشی را مطالعه نمایید تا بتوانید حداکثر استفاده و ایده پردازی را داشته باشید.

در آخرین بخش از آموزش های این بخش، فایل مثال ها به طور کامل قرار داده شده است.

در آخرین بخش از این آموزش فایل کامل مثال ها موجود می باشد.