RI_SDK_executor_State

Информация

RI_SDK - библиотека Robo Intellect Software Development Kit
executor - название группы устройств исполнителей
State - название метода получения состояния компонента группы исполнителей

Сигнатура функции

Shared object

RI_SDK_executor_State(descriptor, state, errorText):errorCode

Golang gRPC

RI_SDK_Executor_State(descriptor int64) (state int64, errorText string, errorCode int64, err error)

Описание метода

Чтение состояния исполнителя.

Записывает в параметр state константу состояния исполнительного устройства с дескриптором равным descriptor

Коды состояния:

1. 0 - Компонент ожидает вызова действий
2. 1 - Компонент выполняет действие
3. 2 - Компонент выполняет простое свечение (только для светодиода)
4. 3 - Компонент выполняет мигание (только для светодиода)
5. 4 - Компонент выполняет мерцание (только для светодиода)

Параметры и возвращаемые значения

Параметр	Тип для Shared object	Тип для Golang gRPC	Описание
descriptor	int (тип C)	int64	Дескриптор компонента группы исполнителей
state	*int (тип C)	int64	Указатель на код состояния исполнителя
errorText	char[1000] (тип C)	string	Текст ошибки (передается как параметр, если происходит ошибка метод записывает в этот параметр текст ошибки)
errorCode	int (тип C)	int64	Код ошибки

Примеры

Пример №1 - Получение состояния компонента группы исполнителей

В данном примере в переменную state записывается состояние компонента группы исполнителей с дескриптором, записанным в переменную descriptor, и последующий вывод значения переменной state.

Python

# Получение состояния исполнительного устройства
errCode = lib.RI_SDK_executor_State(descriptor, state, errTextC)
if errCode != 0:
    print(errCode, errTextC.raw.decode())
    sys.exit(2)

print("state: ", state.value)
    

C

// Получение состояния исполнительного устройства
errCode = RI_SDK_executor_State(descriptor, &state, errorText);
if (errCode != 0) {
    printf("errorText:%s\n", errorText);
    return errCode;
}

printf("state: %d\n", state);
    

C++

// Получение состояния исполнительного устройства
errCode = RI_SDK_executor_State(descriptor, &state, errorText);
if (errCode != 0) {
    printf("errorText:%s\n", errorText);
    return errCode;
}

printf("state: %d\n", state);
    

Golang

// Получение состояния исполнительного устройства
errCode = C.RI_SDK_executor_State(descriptor, &state, &errorTextC[0])
if errCode != 0 {
  fmt.Printf("errorCode:%d - errorText:%s\n", errCode, C.GoString(&errorTextC[0]))
  return
}

fmt.Println("state: ", state)

Golang gRPC

// Получение состояния исполнительного устройства
state, errorText, errCode, err = client.RoboSdkApi.RI_SDK_Executor_State(descriptor)
if err != nil {
  fmt.Printf("gRPC Error: %v\n", err)
  return
}
if errCode != 0 {
  fmt.Printf("errorCode:%d - errorText:%s\n", errCode, errorText)
  return
}

fmt.Println("state: ", state)

PHP

// Получение состояния исполнительного устройства
$errCode = $ffi->RI_SDK_executor_State($descriptor->cdata, FFI::addr($state), $errorText);
if ($errCode) {
    print("errorText:" . FFI::string($errorText). " errCode: " . $errCode . " \n");
    return $errCode;
}

print("state: " . $state->cdata . "\n");

Полный текст примера

Python

from ctypes.util import find_library
import platform
import sys
from ctypes import *

# Подключаем внешнюю библиотеку для работы с SDK
platform = platform.system()
if platform == "Windows":
    libName = "librisdk.dll"
if platform == "Linux":
    libName = "librisdk.so"

pathLib = find_library(libName)
lib = cdll.LoadLibrary(pathLib)


# Указываем типы аргументов для функций библиотеки RI_SDK
lib.RI_SDK_InitSDK.argtypes = [c_int, c_char_p]
lib.RI_SDK_CreateGroupComponent.argtypes = [c_char_p, POINTER(c_int), c_char_p]
lib.RI_SDK_executor_State.argtypes = [c_int, POINTER(c_int), c_char_p]

def main():
    errTextC = create_string_buffer(1000)  # Текст ошибки. C type: char*
    descriptor = c_int()
    state = c_int()

    # Инициализация библиотеки RI SDK с уровнем логирования 3
    errCode = lib.RI_SDK_InitSDK(3, errTextC)
    if errCode != 0:
        print(errCode, errTextC.raw.decode())
        sys.exit(2)

    # Создание компонента группы исполнителей
    errCode = lib.RI_SDK_CreateGroupComponent("executor".encode(), descriptor, errTextC)
    if errCode != 0:
        print(errCode, errTextC.raw.decode())
        sys.exit(2)
    
    print("descriptor: ", descriptor.value)

    # Получение состояния исполнительного устройства
    errCode = lib.RI_SDK_executor_State(descriptor, state, errTextC)
    if errCode != 0:
        print(errCode, errTextC.raw.decode())
        sys.exit(2)

    print("state: ", state.value)

    print("Success")

main()
 

C

#include "./librisdk.h" // Подключение библиотеки

int main(){

    char errorText[1000]; // текст ошибки. Передается как входной параметр,при возникновении ошибки в эту переменную будет записан текст ошибки
    int errCode; //код ошибки
    int state, descriptor; 
    
    // Инициализация библиотеки RI SDK с уровнем логирования 3
    errCode = RI_SDK_InitSDK(3, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    // Создание компонента группы исполнителей
    errCode = RI_SDK_CreateGroupComponent("executor", &descriptor, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    printf("descriptor: %d\n", descriptor);

    // Получение состояния исполнительного устройства
    errCode = RI_SDK_executor_State(descriptor, &state, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    printf("state: %d\n", state);

    printf("Success");
    return 0;
}

C++

#include <stdbool.h>
#include "./librisdk.h" // Подключение библиотеки

int main(){

    char errorText[1000]; // текст ошибки. Передается как входной параметр,при возникновении ошибки в эту переменную будет записан текст ошибки
    int errCode; //код ошибки
    int state, descriptor; 
    
    // Инициализация библиотеки RI SDK с уровнем логирования 3
    errCode = RI_SDK_InitSDK(3, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    // Создание компонента группы исполнителей
    char executor[] = "executor";
    errCode = RI_SDK_CreateGroupComponent(executor, &descriptor, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    printf("descriptor: %d\n", descriptor);

    // Получение состояния исполнительного устройства
    errCode = RI_SDK_executor_State(descriptor, &state, errorText);
    if (errCode != 0) {
        printf("errorText:%s\n", errorText);
        return errCode;
    }

    printf("state: %d\n", state);

    printf("Success");
    return 0;
}

Golang

package main

/*
#cgo CFLAGS: -I.
#cgo LDFLAGS: -L. -lrisdk
#include <librisdk.h> // Подключаем внешнюю библиотеку для работы с SDK.
*/
import "C"
import "fmt"

var (
    errorTextC [1000]C.char // Текст ошибки. C type: char*
    errCode    C.int        // Код ошибки. C type: int
    descriptor C.int
    state      C.int
)

func main() {

    // Инициализация библиотеки RI SDK с уровнем логирования 3
    errCode = C.RI_SDK_InitSDK(3, &errorTextC[0])
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, C.GoString(&errorTextC[0]))
        return
    }

    // Создание компонента группы исполнителей
    errCode = C.RI_SDK_CreateGroupComponent(C.CString("executor"), &descriptor, &errorTextC[0])
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, C.GoString(&errorTextC[0]))
        return
    }

    fmt.Println("descriptor: ", descriptor)

    // Получение состояния исполнительного устройства
    errCode = C.RI_SDK_executor_State(descriptor, &state, &errorTextC[0])
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, C.GoString(&errorTextC[0]))
        return
    }

    fmt.Println("state: ", state)

    fmt.Println("Success")

}

Golang gRPC

package main

import (
    "fmt"

    "github.com/rbs-ri/go-risdk"
)

var (
    client     *risdk.ClientRPC // Объект взяимодействия с API SDK
    errorText  string           // Текст ошибки
    errCode    int64            // Код ошибки
    err        error            // Ошибка gRPC
    descriptor int64
    state      int64
)

func main() {

    // Открываем соединение для работы с API SDK по RPC
    client = risdk.GetClientRPC()

    // Закрываем соединение с RPC
    defer client.Client.Kill()

    // Инициализация библиотеки RI SDK с уровнем логирования 3
    errorText, errCode, err = client.RoboSdkApi.RI_SDK_InitSDK(3)
    if err != nil {
        fmt.Printf("gRPC Error: %v\n", err)
        return
    }
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, errorText)
        return
    }

    // Создание компонента группы исполнителей
    descriptor, errorText, errCode, err = client.RoboSdkApi.RI_SDK_CreateGroupComponent("executor")
    if err != nil {
        fmt.Printf("gRPC Error: %v\n", err)
        return
    }
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, errorText)
        return
    }

    fmt.Println("descriptor: ", descriptor)

    // Получение состояния исполнительного устройства
    state, errorText, errCode, err = client.RoboSdkApi.RI_SDK_Executor_State(descriptor)
    if err != nil {
        fmt.Printf("gRPC Error: %v\n", err)
        return
    }
    if errCode != 0 {
        fmt.Printf("errorCode:%d - errorText:%s\n", errCode, errorText)
        return
    }

    fmt.Println("state: ", state)

    fmt.Println("Success")

}

PHP

<?php
// Подключаем внешнюю библиотеку для работы с SDK
$RELATIVE_PATH = '';
$headers = file_get_contents(__DIR__ . $RELATIVE_PATH . '/librisdk.h');
$headers = preg_replace(['/#ifdef __cplusplus\s*extern "C" {\s*#endif/i', '/#ifdef __cplusplus\s*}\s*#endif/i'], '', $headers);
$ffi = FFI::cdef($headers, __DIR__ . $RELATIVE_PATH . '/librisdk.dll');

$errorText = $ffi->new('char[1000]', 0); // Текст ошибки. Передается как входной параметр,при возникновении ошибки в эту переменную будет записан текст ошибки
$descriptor = $ffi->new('int', 0);
$state = $ffi->new('int', 0);

// Инициализация библиотеки RI SDK с уровнем логирования 3
$errCode = $ffi->RI_SDK_InitSDK(3, $errorText);
if ($errCode) {
    print("errorText:" . FFI::string($errorText) . " errCode: " . $errCode . " \n");
    return $errCode;
}

// Создание базового компонента
$errCode = $ffi->RI_SDK_CreateGroupComponent("executor", FFI::addr($descriptor), $errorText);
if ($errCode) {
    print("errorText:" . FFI::string($errorText). " errCode: " . $errCode . " \n");
    return $errCode;
}

print("descriptor: " . $descriptor->cdata . "\n");

// Получение состояния исполнительного устройства
$errCode = $ffi->RI_SDK_executor_State($descriptor->cdata, FFI::addr($state), $errorText);
if ($errCode) {
    print("errorText:" . FFI::string($errorText). " errCode: " . $errCode . " \n");
    return $errCode;
}

print("state: " . $state->cdata . "\n");

print("Success \n");
?>