IPC Module - Analog Inputs Service

This page contains documentation of the Analog Inputs API.

To measure voltage on a signal (e.g. AIN_5), the user has to request the service, configure the channel and subscribe to the publication of values.

Messages

message analog_inputs_request_req
Parameters:

user (string) – User identifier, max 15 characters long.

Return message:

analog_inputs_request_rsp

Request the analog inputs service.

message analog_inputs_request_rsp
Parameters:

result (enum analog_inputs_result) – Result of the operation

Analog inputs request result.

message analog_inputs_release_req_norsp
Parameters:

user (string) – User identifier, max 15 characters long.

Release analog inputs service for given user user.

message analog_inputs_configure_channel_req
Parameters:
Return message:

analog_inputs_configure_channel_rsp

Request to configure one analog inputs channel.

message analog_inputs_configure_channel_rsp
Parameters:

Sent in response to analog_inputs_configure_channel_req message.

message analog_inputs_values_publish_ind
Parameters:

values (int32[16]) – Values for all configured input channels. The values are mV or Hz for voltage and frequency values, respectively. INT32_MIN means that the channel is turned off. The values are indexed by the ref logical_channels [“logical channels”].

Analog input event. Sent once per second to all subscribers.

message analog_inputs_values_subscribe_req

Subscribe to analog_inputs_values_publish_ind messages

message analog_inputs_values_subscribe_rsp
Parameters:

result (enum ipc_subscribe_result)

Result from analog_inputs_values_subscribe_req

message analog_inputs_values_unsubscribe_req_norsp

Unsubscribe from analog_inputs_values_publish_ind messages

Enums

enum analog_inputs_result

Result codes

Constant

Value

Description

OK

0

OK

ERROR

1

Error

enum analog_inputs_channels

Logical channels. anchor logical_channels These channels (AIN_1 - AIN_8) correspond to physical pins in the main connector.

Constant

Value

Description

AIN_1

0

AIN_1

AIN_2

1

AIN_2

AIN_3

2

AIN_3

AIN_4

3

AIN_4

AIN_5

4

AIN_5

AIN_6

5

AIN_6

AIN_7

6

AIN_7

AIN_8

7

AIN_8

NUMBER_OF_CHANNELS

8

enum analog_inputs_mode

Possible measurement modes for analog inputs.

Constant

Value

Description

OFF

0

OFf

VOLTAGE

1

Voltage

FREQUENCY

2

Frequency