@wandelbots/nova-api 25.8.0-dev.14 → 25.8.0-dev.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +137 -84
- package/v2/api.js +43 -43
- package/v2/api.js.map +1 -1
- package/v2/api.ts +137 -80
package/v2/api.ts
CHANGED
|
@@ -373,7 +373,7 @@ export const BoxBoxTypeEnum = {
|
|
|
373
373
|
export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
|
|
374
374
|
|
|
375
375
|
/**
|
|
376
|
-
* PROFINET BUS
|
|
376
|
+
* PROFINET BUS inputs/outputs service configuration.
|
|
377
377
|
* @export
|
|
378
378
|
* @interface BusIOProfinet
|
|
379
379
|
*/
|
|
@@ -385,19 +385,19 @@ export interface BusIOProfinet {
|
|
|
385
385
|
*/
|
|
386
386
|
'bus_type'?: BusIOProfinetBusTypeEnum;
|
|
387
387
|
/**
|
|
388
|
-
*
|
|
388
|
+
* Content of Configuration XML file for PROFINET device, typically known as PND_IOD.xml. Leave empty for the default configuration. Refer to the official PROFINET driver documentation for further information.
|
|
389
389
|
* @type {string}
|
|
390
390
|
* @memberof BusIOProfinet
|
|
391
391
|
*/
|
|
392
392
|
'config_file_content'?: string;
|
|
393
393
|
/**
|
|
394
|
-
*
|
|
394
|
+
* Used to enable IP communication through the same physical interface while PN Driver is running.
|
|
395
395
|
* @type {BusIOProfinetNetwork}
|
|
396
396
|
* @memberof BusIOProfinet
|
|
397
397
|
*/
|
|
398
398
|
'network_config'?: BusIOProfinetNetwork;
|
|
399
399
|
/**
|
|
400
|
-
* MAC address
|
|
400
|
+
* MAC address of the physical ethernet interface that you want to use for PROFINET communication.
|
|
401
401
|
* @type {string}
|
|
402
402
|
* @memberof BusIOProfinet
|
|
403
403
|
*/
|
|
@@ -417,7 +417,7 @@ export const BusIOProfinetBusTypeEnum = {
|
|
|
417
417
|
export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
|
|
418
418
|
|
|
419
419
|
/**
|
|
420
|
-
*
|
|
420
|
+
* Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
|
|
421
421
|
* @export
|
|
422
422
|
* @interface BusIOProfinetDefaultRoute
|
|
423
423
|
*/
|
|
@@ -436,25 +436,25 @@ export interface BusIOProfinetDefaultRoute {
|
|
|
436
436
|
'interface': string;
|
|
437
437
|
}
|
|
438
438
|
/**
|
|
439
|
-
* Network configuration
|
|
439
|
+
* Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network. The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
440
440
|
* @export
|
|
441
441
|
* @interface BusIOProfinetIpConfig
|
|
442
442
|
*/
|
|
443
443
|
export interface BusIOProfinetIpConfig {
|
|
444
444
|
/**
|
|
445
|
-
* IP address for the
|
|
445
|
+
* IP address for the device\'s virtual ethernet interface (pnio1).
|
|
446
446
|
* @type {string}
|
|
447
447
|
* @memberof BusIOProfinetIpConfig
|
|
448
448
|
*/
|
|
449
449
|
'ip': string;
|
|
450
450
|
/**
|
|
451
|
-
* Network mask for the
|
|
451
|
+
* Network mask for the device\'s virtual ethernet interface (pnio1).
|
|
452
452
|
* @type {string}
|
|
453
453
|
* @memberof BusIOProfinetIpConfig
|
|
454
454
|
*/
|
|
455
455
|
'netmask': string;
|
|
456
456
|
/**
|
|
457
|
-
* Gateway for the
|
|
457
|
+
* Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
|
|
458
458
|
* @type {string}
|
|
459
459
|
* @memberof BusIOProfinetIpConfig
|
|
460
460
|
*/
|
|
@@ -467,7 +467,7 @@ export interface BusIOProfinetIpConfig {
|
|
|
467
467
|
*/
|
|
468
468
|
export interface BusIOProfinetNetwork {
|
|
469
469
|
/**
|
|
470
|
-
* Name of the PROFINET device.
|
|
470
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
|
|
471
471
|
* @type {string}
|
|
472
472
|
* @memberof BusIOProfinetNetwork
|
|
473
473
|
*/
|
|
@@ -479,14 +479,14 @@ export interface BusIOProfinetNetwork {
|
|
|
479
479
|
*/
|
|
480
480
|
'ip_config'?: BusIOProfinetIpConfig;
|
|
481
481
|
/**
|
|
482
|
-
* Content of the PROFINET REMA XML file.
|
|
482
|
+
* Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file. Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
|
|
483
483
|
* @type {string}
|
|
484
484
|
* @memberof BusIOProfinetNetwork
|
|
485
485
|
*/
|
|
486
486
|
'rema_xml_content'?: string;
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
|
-
* Virtual PROFINET BUS
|
|
489
|
+
* Virtual PROFINET BUS inputs/outputs service configuration.
|
|
490
490
|
* @export
|
|
491
491
|
* @interface BusIOProfinetVirtual
|
|
492
492
|
*/
|
|
@@ -500,7 +500,7 @@ export interface BusIOProfinetVirtual {
|
|
|
500
500
|
}
|
|
501
501
|
|
|
502
502
|
export const BusIOProfinetVirtualBusTypeEnum = {
|
|
503
|
-
|
|
503
|
+
ProfinetVirtual: 'profinet_virtual'
|
|
504
504
|
} as const;
|
|
505
505
|
|
|
506
506
|
export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
|
|
@@ -524,7 +524,7 @@ export interface BusIOsState {
|
|
|
524
524
|
*/
|
|
525
525
|
'state': BusIOsStateEnum;
|
|
526
526
|
/**
|
|
527
|
-
* A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
527
|
+
* A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
|
|
528
528
|
* @type {string}
|
|
529
529
|
* @memberof BusIOsState
|
|
530
530
|
*/
|
|
@@ -1876,6 +1876,57 @@ export interface IODescription {
|
|
|
1876
1876
|
}
|
|
1877
1877
|
|
|
1878
1878
|
|
|
1879
|
+
/**
|
|
1880
|
+
*
|
|
1881
|
+
* @export
|
|
1882
|
+
* @interface IODescription2
|
|
1883
|
+
*/
|
|
1884
|
+
export interface IODescription2 {
|
|
1885
|
+
/**
|
|
1886
|
+
* Unique identifier of the input/output.
|
|
1887
|
+
* @type {string}
|
|
1888
|
+
* @memberof IODescription2
|
|
1889
|
+
*/
|
|
1890
|
+
'io': string;
|
|
1891
|
+
/**
|
|
1892
|
+
* Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
1893
|
+
* @type {string}
|
|
1894
|
+
* @memberof IODescription2
|
|
1895
|
+
*/
|
|
1896
|
+
'name': string;
|
|
1897
|
+
/**
|
|
1898
|
+
*
|
|
1899
|
+
* @type {IODirection}
|
|
1900
|
+
* @memberof IODescription2
|
|
1901
|
+
*/
|
|
1902
|
+
'direction': IODirection;
|
|
1903
|
+
/**
|
|
1904
|
+
*
|
|
1905
|
+
* @type {IOValueType}
|
|
1906
|
+
* @memberof IODescription2
|
|
1907
|
+
*/
|
|
1908
|
+
'value_type': IOValueType;
|
|
1909
|
+
/**
|
|
1910
|
+
*
|
|
1911
|
+
* @type {UnitType}
|
|
1912
|
+
* @memberof IODescription2
|
|
1913
|
+
*/
|
|
1914
|
+
'unit'?: UnitType;
|
|
1915
|
+
/**
|
|
1916
|
+
*
|
|
1917
|
+
* @type {IODescriptionMin}
|
|
1918
|
+
* @memberof IODescription2
|
|
1919
|
+
*/
|
|
1920
|
+
'min'?: IODescriptionMin;
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @type {IODescriptionMin}
|
|
1924
|
+
* @memberof IODescription2
|
|
1925
|
+
*/
|
|
1926
|
+
'max'?: IODescriptionMin;
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1929
|
+
|
|
1879
1930
|
/**
|
|
1880
1931
|
* @type IODescriptionMin
|
|
1881
1932
|
* @export
|
|
@@ -2869,6 +2920,12 @@ export interface LimitSet {
|
|
|
2869
2920
|
* @memberof LimitSet
|
|
2870
2921
|
*/
|
|
2871
2922
|
'flange'?: CartesianLimits;
|
|
2923
|
+
/**
|
|
2924
|
+
*
|
|
2925
|
+
* @type {JointLimits}
|
|
2926
|
+
* @memberof LimitSet
|
|
2927
|
+
*/
|
|
2928
|
+
'coupled_shoulder_elbow_joint'?: JointLimits;
|
|
2872
2929
|
}
|
|
2873
2930
|
/**
|
|
2874
2931
|
* If a limit is not set, the default value will be used.
|
|
@@ -4071,17 +4128,17 @@ export interface ProfinetDescription {
|
|
|
4071
4128
|
*/
|
|
4072
4129
|
'slots'?: Array<ProfinetSlotDescription>;
|
|
4073
4130
|
/**
|
|
4074
|
-
* Name of the PROFINET device
|
|
4131
|
+
* Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
|
|
4075
4132
|
* @type {string}
|
|
4076
4133
|
* @memberof ProfinetDescription
|
|
4077
4134
|
*/
|
|
4078
4135
|
'device_name'?: string;
|
|
4079
4136
|
/**
|
|
4080
|
-
*
|
|
4081
|
-
* @type {
|
|
4137
|
+
*
|
|
4138
|
+
* @type {BusIOProfinetIpConfig}
|
|
4082
4139
|
* @memberof ProfinetDescription
|
|
4083
4140
|
*/
|
|
4084
|
-
'
|
|
4141
|
+
'ip_config'?: BusIOProfinetIpConfig;
|
|
4085
4142
|
}
|
|
4086
4143
|
/**
|
|
4087
4144
|
*
|
|
@@ -4090,7 +4147,7 @@ export interface ProfinetDescription {
|
|
|
4090
4147
|
*/
|
|
4091
4148
|
export interface ProfinetIO {
|
|
4092
4149
|
/**
|
|
4093
|
-
* The name of the input/output
|
|
4150
|
+
* The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
|
|
4094
4151
|
* @type {string}
|
|
4095
4152
|
* @memberof ProfinetIO
|
|
4096
4153
|
*/
|
|
@@ -4102,25 +4159,25 @@ export interface ProfinetIO {
|
|
|
4102
4159
|
*/
|
|
4103
4160
|
'type': ProfinetIOTypeEnum;
|
|
4104
4161
|
/**
|
|
4105
|
-
* The direction of the input/output
|
|
4162
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4106
4163
|
* @type {ProfinetIODirection}
|
|
4107
4164
|
* @memberof ProfinetIO
|
|
4108
4165
|
*/
|
|
4109
4166
|
'direction': ProfinetIODirection;
|
|
4110
4167
|
/**
|
|
4111
|
-
* The byte address of the input/output
|
|
4168
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
4112
4169
|
* @type {number}
|
|
4113
4170
|
* @memberof ProfinetIO
|
|
4114
4171
|
*/
|
|
4115
4172
|
'byte_address': number;
|
|
4116
4173
|
/**
|
|
4117
|
-
* The bit address of the input/output
|
|
4174
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
4118
4175
|
* @type {number}
|
|
4119
4176
|
* @memberof ProfinetIO
|
|
4120
4177
|
*/
|
|
4121
4178
|
'bit_address'?: number;
|
|
4122
4179
|
/**
|
|
4123
|
-
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA
|
|
4180
|
+
* The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4124
4181
|
* @type {string}
|
|
4125
4182
|
* @memberof ProfinetIO
|
|
4126
4183
|
*/
|
|
@@ -4135,7 +4192,7 @@ export interface ProfinetIO {
|
|
|
4135
4192
|
*/
|
|
4136
4193
|
export interface ProfinetIOData {
|
|
4137
4194
|
/**
|
|
4138
|
-
* The name of the input/output
|
|
4195
|
+
* The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
|
|
4139
4196
|
* @type {string}
|
|
4140
4197
|
* @memberof ProfinetIOData
|
|
4141
4198
|
*/
|
|
@@ -4147,19 +4204,19 @@ export interface ProfinetIOData {
|
|
|
4147
4204
|
*/
|
|
4148
4205
|
'type': ProfinetIOTypeEnum;
|
|
4149
4206
|
/**
|
|
4150
|
-
* The direction of the input/output
|
|
4207
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4151
4208
|
* @type {ProfinetIODirection}
|
|
4152
4209
|
* @memberof ProfinetIOData
|
|
4153
4210
|
*/
|
|
4154
4211
|
'direction': ProfinetIODirection;
|
|
4155
4212
|
/**
|
|
4156
|
-
* The byte address of the input/output
|
|
4213
|
+
* The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
|
|
4157
4214
|
* @type {number}
|
|
4158
4215
|
* @memberof ProfinetIOData
|
|
4159
4216
|
*/
|
|
4160
4217
|
'byte_address': number;
|
|
4161
4218
|
/**
|
|
4162
|
-
* The bit address of the input/output
|
|
4219
|
+
* The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
|
|
4163
4220
|
* @type {number}
|
|
4164
4221
|
* @memberof ProfinetIOData
|
|
4165
4222
|
*/
|
|
@@ -4168,7 +4225,7 @@ export interface ProfinetIOData {
|
|
|
4168
4225
|
|
|
4169
4226
|
|
|
4170
4227
|
/**
|
|
4171
|
-
*
|
|
4228
|
+
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
4172
4229
|
* @export
|
|
4173
4230
|
* @enum {string}
|
|
4174
4231
|
*/
|
|
@@ -4183,7 +4240,7 @@ export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof Profin
|
|
|
4183
4240
|
|
|
4184
4241
|
|
|
4185
4242
|
/**
|
|
4186
|
-
* Value type of the PROFINET input/output.
|
|
4243
|
+
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
|
|
4187
4244
|
* @export
|
|
4188
4245
|
* @enum {string}
|
|
4189
4246
|
*/
|
|
@@ -4211,38 +4268,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
|
|
|
4211
4268
|
*/
|
|
4212
4269
|
export interface ProfinetInputOutputConfig {
|
|
4213
4270
|
/**
|
|
4214
|
-
* Content of the input
|
|
4271
|
+
* Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
|
|
4215
4272
|
* @type {string}
|
|
4216
4273
|
* @memberof ProfinetInputOutputConfig
|
|
4217
4274
|
*/
|
|
4218
4275
|
'config': string;
|
|
4219
4276
|
/**
|
|
4220
|
-
* Offset in bytes for the input
|
|
4277
|
+
* Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4221
4278
|
* @type {number}
|
|
4222
4279
|
* @memberof ProfinetInputOutputConfig
|
|
4223
4280
|
*/
|
|
4224
4281
|
'input_offset': number;
|
|
4225
4282
|
/**
|
|
4226
|
-
* Offset in bytes for the output
|
|
4283
|
+
* Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
|
|
4227
4284
|
* @type {number}
|
|
4228
4285
|
* @memberof ProfinetInputOutputConfig
|
|
4229
4286
|
*/
|
|
4230
4287
|
'output_offset': number;
|
|
4231
4288
|
}
|
|
4232
4289
|
/**
|
|
4233
|
-
*
|
|
4290
|
+
* An array of PROFINET slots. PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
|
|
4234
4291
|
* @export
|
|
4235
4292
|
* @interface ProfinetSlotDescription
|
|
4236
4293
|
*/
|
|
4237
4294
|
export interface ProfinetSlotDescription {
|
|
4238
4295
|
/**
|
|
4239
|
-
* The number of the PROFINET slot.
|
|
4296
|
+
* The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
|
|
4240
4297
|
* @type {number}
|
|
4241
4298
|
* @memberof ProfinetSlotDescription
|
|
4242
4299
|
*/
|
|
4243
4300
|
'number': number;
|
|
4244
4301
|
/**
|
|
4245
|
-
* The API number of the PROFINET input
|
|
4302
|
+
* The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
|
|
4246
4303
|
* @type {number}
|
|
4247
4304
|
* @memberof ProfinetSlotDescription
|
|
4248
4305
|
*/
|
|
@@ -4261,19 +4318,19 @@ export interface ProfinetSlotDescription {
|
|
|
4261
4318
|
*/
|
|
4262
4319
|
export interface ProfinetSubSlotDescription {
|
|
4263
4320
|
/**
|
|
4264
|
-
* The
|
|
4321
|
+
* The number/index of the PROFINET subslot.
|
|
4265
4322
|
* @type {number}
|
|
4266
4323
|
* @memberof ProfinetSubSlotDescription
|
|
4267
4324
|
*/
|
|
4268
4325
|
'number': number;
|
|
4269
4326
|
/**
|
|
4270
|
-
* The
|
|
4327
|
+
* The amount of bytes allocated for the subslot in the input process image buffer.
|
|
4271
4328
|
* @type {number}
|
|
4272
4329
|
* @memberof ProfinetSubSlotDescription
|
|
4273
4330
|
*/
|
|
4274
4331
|
'input_length': number;
|
|
4275
4332
|
/**
|
|
4276
|
-
* The
|
|
4333
|
+
* The amount of bytes allocated for the subslot in the output process image buffer.
|
|
4277
4334
|
* @type {number}
|
|
4278
4335
|
* @memberof ProfinetSubSlotDescription
|
|
4279
4336
|
*/
|
|
@@ -6150,7 +6207,7 @@ export class ApplicationApi extends BaseAPI {
|
|
|
6150
6207
|
export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6151
6208
|
return {
|
|
6152
6209
|
/**
|
|
6153
|
-
* Add
|
|
6210
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6154
6211
|
* @summary Add Service
|
|
6155
6212
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6156
6213
|
* @param {BusIOType} busIOType
|
|
@@ -6203,7 +6260,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6203
6260
|
};
|
|
6204
6261
|
},
|
|
6205
6262
|
/**
|
|
6206
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6263
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
6207
6264
|
* @summary Add PROFINET Input/Output
|
|
6208
6265
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6209
6266
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6255,7 +6312,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6255
6312
|
};
|
|
6256
6313
|
},
|
|
6257
6314
|
/**
|
|
6258
|
-
*
|
|
6315
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6259
6316
|
* @summary Clear Service
|
|
6260
6317
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6261
6318
|
* @param {number} [completionTimeout]
|
|
@@ -6302,7 +6359,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6302
6359
|
};
|
|
6303
6360
|
},
|
|
6304
6361
|
/**
|
|
6305
|
-
* Removes
|
|
6362
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6306
6363
|
* @summary Remove PROFINET Input/Ouptut
|
|
6307
6364
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6308
6365
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6348,7 +6405,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6348
6405
|
};
|
|
6349
6406
|
},
|
|
6350
6407
|
/**
|
|
6351
|
-
* Get deployed BUS
|
|
6408
|
+
* Get deployed BUS inputs/outputs service.
|
|
6352
6409
|
* @summary Get Service
|
|
6353
6410
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
6411
|
* @param {*} [options] Override http request option.
|
|
@@ -6479,7 +6536,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6479
6536
|
};
|
|
6480
6537
|
},
|
|
6481
6538
|
/**
|
|
6482
|
-
* Get description of PROFINET
|
|
6539
|
+
* Get description of NOVA as a PROFINET device.
|
|
6483
6540
|
* @summary Get PROFINET Description
|
|
6484
6541
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6485
6542
|
* @param {*} [options] Override http request option.
|
|
@@ -6521,7 +6578,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6521
6578
|
};
|
|
6522
6579
|
},
|
|
6523
6580
|
/**
|
|
6524
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6581
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
6525
6582
|
* @summary PROFINET Inputs/Outputs to File
|
|
6526
6583
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
6584
|
* @param {number} [inputOffset]
|
|
@@ -6573,7 +6630,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6573
6630
|
};
|
|
6574
6631
|
},
|
|
6575
6632
|
/**
|
|
6576
|
-
* List all BUS
|
|
6633
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
6577
6634
|
* @summary List Descriptions
|
|
6578
6635
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6579
6636
|
* @param {*} [options] Override http request option.
|
|
@@ -6615,7 +6672,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6615
6672
|
};
|
|
6616
6673
|
},
|
|
6617
6674
|
/**
|
|
6618
|
-
* List all PROFINET input and
|
|
6675
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6619
6676
|
* @summary List PROFINET Input/Output Configuration
|
|
6620
6677
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6621
6678
|
* @param {*} [options] Override http request option.
|
|
@@ -6705,7 +6762,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
|
|
|
6705
6762
|
};
|
|
6706
6763
|
},
|
|
6707
6764
|
/**
|
|
6708
|
-
* Sets
|
|
6765
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
6709
6766
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6710
6767
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6711
6768
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6763,7 +6820,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6763
6820
|
const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration)
|
|
6764
6821
|
return {
|
|
6765
6822
|
/**
|
|
6766
|
-
* Add
|
|
6823
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6767
6824
|
* @summary Add Service
|
|
6768
6825
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6769
6826
|
* @param {BusIOType} busIOType
|
|
@@ -6778,7 +6835,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6778
6835
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6779
6836
|
},
|
|
6780
6837
|
/**
|
|
6781
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
6838
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
6782
6839
|
* @summary Add PROFINET Input/Output
|
|
6783
6840
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6784
6841
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6793,7 +6850,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6793
6850
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6794
6851
|
},
|
|
6795
6852
|
/**
|
|
6796
|
-
*
|
|
6853
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6797
6854
|
* @summary Clear Service
|
|
6798
6855
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6799
6856
|
* @param {number} [completionTimeout]
|
|
@@ -6807,7 +6864,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6807
6864
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6808
6865
|
},
|
|
6809
6866
|
/**
|
|
6810
|
-
* Removes
|
|
6867
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6811
6868
|
* @summary Remove PROFINET Input/Ouptut
|
|
6812
6869
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6813
6870
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6821,7 +6878,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6821
6878
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6822
6879
|
},
|
|
6823
6880
|
/**
|
|
6824
|
-
* Get deployed BUS
|
|
6881
|
+
* Get deployed BUS inputs/outputs service.
|
|
6825
6882
|
* @summary Get Service
|
|
6826
6883
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6827
6884
|
* @param {*} [options] Override http request option.
|
|
@@ -6861,7 +6918,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6861
6918
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6862
6919
|
},
|
|
6863
6920
|
/**
|
|
6864
|
-
* Get description of PROFINET
|
|
6921
|
+
* Get description of NOVA as a PROFINET device.
|
|
6865
6922
|
* @summary Get PROFINET Description
|
|
6866
6923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6867
6924
|
* @param {*} [options] Override http request option.
|
|
@@ -6874,7 +6931,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6874
6931
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6875
6932
|
},
|
|
6876
6933
|
/**
|
|
6877
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
6934
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
6878
6935
|
* @summary PROFINET Inputs/Outputs to File
|
|
6879
6936
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6880
6937
|
* @param {number} [inputOffset]
|
|
@@ -6889,20 +6946,20 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6889
6946
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6890
6947
|
},
|
|
6891
6948
|
/**
|
|
6892
|
-
* List all BUS
|
|
6949
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
6893
6950
|
* @summary List Descriptions
|
|
6894
6951
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6895
6952
|
* @param {*} [options] Override http request option.
|
|
6896
6953
|
* @throws {RequiredError}
|
|
6897
6954
|
*/
|
|
6898
|
-
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
6955
|
+
async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>> {
|
|
6899
6956
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
|
|
6900
6957
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6901
6958
|
const localVarOperationServerBasePath = operationServerMap['BUSInputsOutputsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
|
|
6902
6959
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6903
6960
|
},
|
|
6904
6961
|
/**
|
|
6905
|
-
* List all PROFINET input and
|
|
6962
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
6906
6963
|
* @summary List PROFINET Input/Output Configuration
|
|
6907
6964
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6908
6965
|
* @param {*} [options] Override http request option.
|
|
@@ -6929,7 +6986,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
|
|
|
6929
6986
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6930
6987
|
},
|
|
6931
6988
|
/**
|
|
6932
|
-
* Sets
|
|
6989
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
6933
6990
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
6934
6991
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6935
6992
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -6953,7 +7010,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6953
7010
|
const localVarFp = BUSInputsOutputsApiFp(configuration)
|
|
6954
7011
|
return {
|
|
6955
7012
|
/**
|
|
6956
|
-
* Add
|
|
7013
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
6957
7014
|
* @summary Add Service
|
|
6958
7015
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6959
7016
|
* @param {BusIOType} busIOType
|
|
@@ -6965,7 +7022,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6965
7022
|
return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6966
7023
|
},
|
|
6967
7024
|
/**
|
|
6968
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7025
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
6969
7026
|
* @summary Add PROFINET Input/Output
|
|
6970
7027
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6971
7028
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6977,7 +7034,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6977
7034
|
return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
|
|
6978
7035
|
},
|
|
6979
7036
|
/**
|
|
6980
|
-
*
|
|
7037
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
6981
7038
|
* @summary Clear Service
|
|
6982
7039
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6983
7040
|
* @param {number} [completionTimeout]
|
|
@@ -6988,7 +7045,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6988
7045
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
6989
7046
|
},
|
|
6990
7047
|
/**
|
|
6991
|
-
* Removes
|
|
7048
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
6992
7049
|
* @summary Remove PROFINET Input/Ouptut
|
|
6993
7050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6994
7051
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -6999,7 +7056,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
6999
7056
|
return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
|
|
7000
7057
|
},
|
|
7001
7058
|
/**
|
|
7002
|
-
* Get deployed BUS
|
|
7059
|
+
* Get deployed BUS inputs/outputs service.
|
|
7003
7060
|
* @summary Get Service
|
|
7004
7061
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7005
7062
|
* @param {*} [options] Override http request option.
|
|
@@ -7030,7 +7087,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7030
7087
|
return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
|
|
7031
7088
|
},
|
|
7032
7089
|
/**
|
|
7033
|
-
* Get description of PROFINET
|
|
7090
|
+
* Get description of NOVA as a PROFINET device.
|
|
7034
7091
|
* @summary Get PROFINET Description
|
|
7035
7092
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7036
7093
|
* @param {*} [options] Override http request option.
|
|
@@ -7040,7 +7097,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7040
7097
|
return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
|
|
7041
7098
|
},
|
|
7042
7099
|
/**
|
|
7043
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7100
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
7044
7101
|
* @summary PROFINET Inputs/Outputs to File
|
|
7045
7102
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7046
7103
|
* @param {number} [inputOffset]
|
|
@@ -7052,17 +7109,17 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7052
7109
|
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
7053
7110
|
},
|
|
7054
7111
|
/**
|
|
7055
|
-
* List all BUS
|
|
7112
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
7056
7113
|
* @summary List Descriptions
|
|
7057
7114
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7058
7115
|
* @param {*} [options] Override http request option.
|
|
7059
7116
|
* @throws {RequiredError}
|
|
7060
7117
|
*/
|
|
7061
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
7118
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>> {
|
|
7062
7119
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
7063
7120
|
},
|
|
7064
7121
|
/**
|
|
7065
|
-
* List all PROFINET input and
|
|
7122
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
7066
7123
|
* @summary List PROFINET Input/Output Configuration
|
|
7067
7124
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7068
7125
|
* @param {*} [options] Override http request option.
|
|
@@ -7083,7 +7140,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7083
7140
|
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
7084
7141
|
},
|
|
7085
7142
|
/**
|
|
7086
|
-
* Sets
|
|
7143
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
7087
7144
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7088
7145
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
7146
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -7104,7 +7161,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
|
|
|
7104
7161
|
*/
|
|
7105
7162
|
export class BUSInputsOutputsApi extends BaseAPI {
|
|
7106
7163
|
/**
|
|
7107
|
-
* Add
|
|
7164
|
+
* Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
|
|
7108
7165
|
* @summary Add Service
|
|
7109
7166
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7110
7167
|
* @param {BusIOType} busIOType
|
|
@@ -7118,7 +7175,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7118
7175
|
}
|
|
7119
7176
|
|
|
7120
7177
|
/**
|
|
7121
|
-
* Adds an input/output to or updates an input/output on the PROFINET device.
|
|
7178
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
|
|
7122
7179
|
* @summary Add PROFINET Input/Output
|
|
7123
7180
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7124
7181
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7132,7 +7189,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7132
7189
|
}
|
|
7133
7190
|
|
|
7134
7191
|
/**
|
|
7135
|
-
*
|
|
7192
|
+
* Remove the BUS inputs/outputs service from the cell.
|
|
7136
7193
|
* @summary Clear Service
|
|
7137
7194
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7138
7195
|
* @param {number} [completionTimeout]
|
|
@@ -7145,7 +7202,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7145
7202
|
}
|
|
7146
7203
|
|
|
7147
7204
|
/**
|
|
7148
|
-
* Removes
|
|
7205
|
+
* Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
|
|
7149
7206
|
* @summary Remove PROFINET Input/Ouptut
|
|
7150
7207
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7151
7208
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -7158,7 +7215,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7158
7215
|
}
|
|
7159
7216
|
|
|
7160
7217
|
/**
|
|
7161
|
-
* Get deployed BUS
|
|
7218
|
+
* Get deployed BUS inputs/outputs service.
|
|
7162
7219
|
* @summary Get Service
|
|
7163
7220
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7164
7221
|
* @param {*} [options] Override http request option.
|
|
@@ -7195,7 +7252,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7195
7252
|
}
|
|
7196
7253
|
|
|
7197
7254
|
/**
|
|
7198
|
-
* Get description of PROFINET
|
|
7255
|
+
* Get description of NOVA as a PROFINET device.
|
|
7199
7256
|
* @summary Get PROFINET Description
|
|
7200
7257
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7201
7258
|
* @param {*} [options] Override http request option.
|
|
@@ -7207,7 +7264,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7207
7264
|
}
|
|
7208
7265
|
|
|
7209
7266
|
/**
|
|
7210
|
-
* Get input/output configuration of the PROFINET device as file.
|
|
7267
|
+
* Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
|
|
7211
7268
|
* @summary PROFINET Inputs/Outputs to File
|
|
7212
7269
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7213
7270
|
* @param {number} [inputOffset]
|
|
@@ -7221,7 +7278,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7221
7278
|
}
|
|
7222
7279
|
|
|
7223
7280
|
/**
|
|
7224
|
-
* List all BUS
|
|
7281
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
|
|
7225
7282
|
* @summary List Descriptions
|
|
7226
7283
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7227
7284
|
* @param {*} [options] Override http request option.
|
|
@@ -7233,7 +7290,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7233
7290
|
}
|
|
7234
7291
|
|
|
7235
7292
|
/**
|
|
7236
|
-
* List all PROFINET input and
|
|
7293
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an I/O variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
7237
7294
|
* @summary List PROFINET Input/Output Configuration
|
|
7238
7295
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7239
7296
|
* @param {*} [options] Override http request option.
|
|
@@ -7258,7 +7315,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
7258
7315
|
}
|
|
7259
7316
|
|
|
7260
7317
|
/**
|
|
7261
|
-
* Sets
|
|
7318
|
+
* Sets Input/Output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The Inputs/Outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled, meaning that you can paste the exported XML file here without modifying.
|
|
7262
7319
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
7263
7320
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7264
7321
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|