- Распечатать
Как использовать API атрибутов машины
Создайте машину Tulip Machine, используя данные из Node-RED, Python или других сервисов.
Продвинутая статья - предполагает предыдущий опыт работы с REST API
Резюме
API атрибутов машины позволяет вам отправлять данные на определенный атрибут машины через RESTful API, используя конечную точку /attributes/report
. Это дает множество гибких возможностей для интеграции с Tulip из Node-RED, Python или других языков и сервисов.
Настройка API машины
Примечание: Если у вас уже настроен API Tulip Table, вы можете использовать ключ и секрет API.
- Перейдите в Настройки > Боты
- Нажмите Создать бота в правом верхнем углу экрана
- Назовите своего бота и выберите для его области действия
атрибуты:write
:
{height="" width=""}.
- Появится модальное окно с вашим ключом API, секретом и заголовком Auth. Пожалуйста, сохраните эту информацию, так как она не может быть получена снова!
Поздравляем - вы официально настроили свой Machine API!
Настройка новой машины
После настройки API Machine на вашем экземпляре появится новый источник данных Machine. Чтобы просмотреть этот источник данных, нажмите Shop Floor > Machines и перейдите к Machine Data Sources:
{height="" width=""}.
Вам нужно будет создать новый станок, связанный с этим источником данных. Чтобы создать новый станок, перейдите в раздел Библиотека станков и нажмите кнопку Создать станок.
Появится следующее модальное окно:
- Имя машины (требуется): Имя вашей машины
- Источник данных машины (Требуется): Выберите Tulip API
- Станция (Необязательно)
- Type (Требуется): Если тип недоступен, сначала создайте тип, в данном примере созданный тип называется default.
Теперь, когда машина создана, вам нужно добавить атрибут. Нажмите на кнопку Edit в правом верхнем углу экрана. Затем нажмите на кнопку + в правом верхнем углу экрана:
{height="" width=""}.
Поскольку атрибуты машины еще не созданы, нажмите на тип машины, выделенный синим цветом, в данном случае это Default.
Это приведет вас к типу машины, связанному с машиной. Нажмите кнопку Edit в правом верхнем углу экрана.
Затем нажмите кнопку + рядом с Атрибуты машины в левом нижнем углу.
Теперь нажмите + Создать атрибут машины в правом нижнем углу.
Для этого примера мы создадим атрибут счетчика типа Integer.
{height="" width=""}.
После того как атрибут создан, щелкните атрибут счетчика в списке атрибутов машины, а затем нажмите кнопку сохранения в правом верхнем углу.
Вернитесь на страницу вашей машины.
Теперь, когда ваш атрибут машины создан, вы можете добавить его к вашей машине. Нажмите кнопку Редактировать в правом верхнем углу. Затем нажмите на кнопку + в правом верхнем углу и выберите атрибут счетчика, который вы только что создали:
{height="" width=""}.
Нажмите кнопку Сохранить в правом верхнем углу.
Ваш экземпляр Tulip теперь настроен с помощью API Machine, машины и атрибута Machine - теперь вы можете отправлять данные на машину Tulip из любого места!
Отсюда вы можете увидеть attributeId
и machineID
для атрибута Counter. Эту информацию можно скопировать, нажав на значок, и она будет использована в теле http-запроса.
Для этого вам потребуется знакомство с REST API. Полную документацию по использованию конечной точки /attributes/report
, включая параметры запроса и формат тела, можно найти на сайте your-company.tulip.co/apidocs или по ссылке на странице Боты...
... и в документации есть раздел "Мониторинг машин".
{height="" width=""}.
Дальнейшее чтение
Посмотрите эту статью, если вы хотите углубиться в API и посмотреть, как его можно использовать с Edge MC и Node-RED!