Интеграция с ParticleIO

Prev Next

Легко подключите Tulip к устройствам ParticleIO

Ознакомьтесь с руководством по интеграции в сообществе Particle (идентичное руководство) здесь:Интеграция в сообществе Particle <> Tulip

Настройка

Настройка конечной точки оборудования в Tulip

Для создания машины в Tulip требуется следующее:* Учетные данные API* Тип машины* Учетные данные API

Учетные данные API:::(Info) (Feature rename)
Prior to r383, Service Accounts were called "API Tokens".
:::

Перейдите в «Настройки» --> «API Tulip», чтобы создать служебную учетную запись с правами на чтение и запись данных для машин и атрибутовimage.png

Тип машины Перейдитев раздел «Производственный цех» → «Машины» → «Типы машин» и создайте новый тип машины. Создайте атрибуты машины, отражающие события, публикуемые из ParticleIO. ПРИМЕЧАНИЕ: Тип данных должен быть строковым. image.png

Станок: Создайтеновый станок в рамках только что созданного типа станков; в разделе «Конфигурация» сопоставьте атрибут станка с API Tulip Machine и запишите MachineId и AttributeIdimage.png

Включение интеграции

Консоль Particle Теперь, когда вы выполнили всю необходимую предварительную настройку, вы готовы включить интеграцию с Tulip в консоли Particle.

Для начала перейдите в центр интеграций, нажав на значок интеграций в боковой панели () или просто перейдя по этой ссылке. Если вы хотите включить интеграцию для какого-либо продукта, вам нужно перейти в центр интеграций для нужного продукта. Для этого нажмите на значок «Продукты» () на боковой панели, найдите нужный продукт, а затем нажмите на значок интеграций () в контексте продукта.

Оказавшись в центре интеграций, нажмите кнопку «Новая интеграция». В списке доступных интеграций выберите «Webhook».

Следующим шагом является настройка веб-хука. Заполните следующие поля:

  • Название события: название события, которое будет инициировать публикацию события в Tulip Machine. Это название вашего события при вызове Particle.publish() в вашей прошивке.
  • URL: полный URL-адрес API Tulip Machine. Пример: https://[instance].tulip.co/api/v3/attributes/report
  • Тип запроса: сервер Tulip ожидает запрос POST, поэтому убедитесь, что выбран именно этот тип.
  • Формат запроса: по умолчанию установлен «Web Form», но мы будем отправлять JSON, поэтому убедитесь, что вы изменили этот параметр на «JSON».

Вам нужно перейти в раздел «Дополнительные настройки», чтобы заполнить пользовательский формат JSON. Вы можете заполнить его следующим образом:

{ "attributes": [ { "machineId": "machineID", "attributeId": "attributeID", "value": "{{{PARTICLE_EVENT_VALUE}}}" } ]}

Аутентификация Наконец, вам нужно будет пройти аутентификацию в Tulip с помощью ключа API и секретного ключа. Пример показан на скриншоте ниже.tulip_api_auth.jpg

В данном случае используется базовая аутентификация (Basic Auth).

Нажмите «Создать веб-хук». Теперь вы успешно настроили облако Particle на передачу данных в Tulip через MachineAPI!

Пора перейти к прошивке!

Прошивка

Теперь, когда интеграция включена в облаке Particle, последним шагом, необходимым для начала потоковой передачи данных в Tulip, является запись на устройство прошивки, которая публикует нужное событие. Перейдите в Particle Web IDE, Local IDE или любую другую среду разработки, которую вы используете для создания прошивки.

Если вы уже работаете над приложением прошивки, просто убедитесь, что вы включили вызов Particle.publish() с именем события, соответствующим событию, использованному для включения интеграции с Google Cloud Platform выше. В противном случае, если вам нужен пример прошивки, вставьте приведенный ниже код в ваше приложение прошивки:


void loop() {

// случайные данные String data = String((rand()%100)+1); // Запуск интеграции Particle.publish("temperature", data, PRIVATE); // Ожидание 6 секунд delay(6000);}```Приведенный выше код будет публиковать событие каждые 6 секунд: сначала генерируется случайное число, а затем оно публикуется в событии webook.

Прошейте прошивку с функцией Particle.publish(), которая запустит интеграцию с устройством Particle.

Поздравляем! Это всё, что нужно для полноценной работы интеграции. Ваше устройство начнёт публиковать целевое событие, которое будет сигнализировать облаку Particle о необходимости передачи содержимого события в ваш экземпляр Tulip.

### Проверка поступления данных в Tulip

Чтобы убедиться, что данные успешно публикуются в Tulip, вы можете просмотреть обновления оборудования в разделе «Производственный цех» (Shop Floor) → «Оборудование» (Machines)

![image.png](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/image%28202%29.png){height="" width=""}

ПРИМЕЧАНИЕ: Атрибут может потребоваться сначала привести в строковый формат, а затем преобразовать.

### Примеры использования

Использование плат ParticleIO, таких как Boron404x, отлично подходит в случаях, когда Wi-Fi работает плохо, а сотовая связь является более быстрым обходным решением для подключения устройств. Среди вариантов использования могут быть:\* Отслеживание материалов\* Мониторинг оборудования\* Обновления данных о качестве в режиме реального времени