@digipair/skill-serialport 0.131.8
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/README.md +7 -0
- package/dist/index.cjs.js +68 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +10152 -0
- package/dist/schema.fr.json +140 -0
- package/dist/schema.json +140 -0
- package/dist/src/index.d.ts +2 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/lib/skill-serialport.d.ts +4 -0
- package/dist/src/lib/skill-serialport.d.ts.map +1 -0
- package/package.json +35 -0
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "@digipair/skill-serialport",
|
|
5
|
+
"summary": "Communication Série",
|
|
6
|
+
"description": "Communiquer avec des appareils via port série (écrire des données et envoyer des commandes)",
|
|
7
|
+
"version": "0.1.0",
|
|
8
|
+
"x-icon": "🔌"
|
|
9
|
+
},
|
|
10
|
+
"paths": {
|
|
11
|
+
"/write": {
|
|
12
|
+
"post": {
|
|
13
|
+
"tags": [
|
|
14
|
+
"service"
|
|
15
|
+
],
|
|
16
|
+
"summary": "Écrire des données",
|
|
17
|
+
"description": "Écrire des données sur un port série sans attendre de réponse",
|
|
18
|
+
"parameters": [
|
|
19
|
+
{
|
|
20
|
+
"name": "data",
|
|
21
|
+
"summary": "Données à écrire",
|
|
22
|
+
"required": true,
|
|
23
|
+
"description": "Les données à écrire sur le port série (tableau d'octets ou buffer)",
|
|
24
|
+
"schema": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"items": {
|
|
27
|
+
"type": "number"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "sleep",
|
|
33
|
+
"summary": "Durée d'attente",
|
|
34
|
+
"required": false,
|
|
35
|
+
"description": "Temps d'attente en millisecondes après l'écriture (par défaut: 1000)",
|
|
36
|
+
"schema": {
|
|
37
|
+
"type": "number",
|
|
38
|
+
"default": 1000
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "config",
|
|
43
|
+
"summary": "Configuration Port Série",
|
|
44
|
+
"required": false,
|
|
45
|
+
"description": "Configuration du port série (optionnelle, utilise SERIALPORT_CONFIG du contexte si non fournie)",
|
|
46
|
+
"schema": {
|
|
47
|
+
"type": "object"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
],
|
|
51
|
+
"responses": {
|
|
52
|
+
"200": {
|
|
53
|
+
"description": "Opération d'écriture terminée avec succès",
|
|
54
|
+
"content": {
|
|
55
|
+
"application/json": {
|
|
56
|
+
"schema": {
|
|
57
|
+
"type": "object",
|
|
58
|
+
"description": "Objet de réponse vide indiquant une écriture réussie"
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"x-events": []
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"/command": {
|
|
68
|
+
"post": {
|
|
69
|
+
"tags": [
|
|
70
|
+
"service"
|
|
71
|
+
],
|
|
72
|
+
"summary": "Envoyer une commande",
|
|
73
|
+
"description": "Envoyer une commande à un appareil sur port série et attendre une réponse",
|
|
74
|
+
"parameters": [
|
|
75
|
+
{
|
|
76
|
+
"name": "data",
|
|
77
|
+
"summary": "Données de commande",
|
|
78
|
+
"required": true,
|
|
79
|
+
"description": "Les données de commande à envoyer sur le port série (tableau d'octets ou buffer)",
|
|
80
|
+
"schema": {
|
|
81
|
+
"type": "array",
|
|
82
|
+
"items": {
|
|
83
|
+
"type": "number"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "sleep",
|
|
89
|
+
"summary": "Durée d'attente",
|
|
90
|
+
"required": false,
|
|
91
|
+
"description": "Temps d'attente en millisecondes après l'envoi de la commande (par défaut: 1000)",
|
|
92
|
+
"schema": {
|
|
93
|
+
"type": "number",
|
|
94
|
+
"default": 1000
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "timeout",
|
|
99
|
+
"summary": "Délai d'attente de réponse",
|
|
100
|
+
"required": false,
|
|
101
|
+
"description": "Temps maximum d'attente pour une réponse en millisecondes (par défaut: 3000)",
|
|
102
|
+
"schema": {
|
|
103
|
+
"type": "number",
|
|
104
|
+
"default": 3000
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "config",
|
|
109
|
+
"summary": "Configuration Port Série",
|
|
110
|
+
"required": false,
|
|
111
|
+
"description": "Configuration du port série (optionnelle, utilise SERIALPORT_CONFIG du contexte si non fournie)",
|
|
112
|
+
"schema": {
|
|
113
|
+
"type": "object"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
],
|
|
117
|
+
"responses": {
|
|
118
|
+
"200": {
|
|
119
|
+
"description": "Données de réponse reçues de l'appareil sur port série",
|
|
120
|
+
"content": {
|
|
121
|
+
"application/json": {
|
|
122
|
+
"schema": {
|
|
123
|
+
"type": "array",
|
|
124
|
+
"items": {
|
|
125
|
+
"type": "number"
|
|
126
|
+
},
|
|
127
|
+
"description": "Tableau d'octets reçus en réponse de l'appareil"
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"x-events": []
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
"components": {
|
|
138
|
+
"schemas": {}
|
|
139
|
+
}
|
|
140
|
+
}
|
package/dist/schema.json
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "@digipair/skill-serialport",
|
|
5
|
+
"summary": "Serial Port Communication",
|
|
6
|
+
"description": "Communicate with devices via serial port (write data and send commands)",
|
|
7
|
+
"version": "0.1.0",
|
|
8
|
+
"x-icon": "🔌"
|
|
9
|
+
},
|
|
10
|
+
"paths": {
|
|
11
|
+
"/write": {
|
|
12
|
+
"post": {
|
|
13
|
+
"tags": [
|
|
14
|
+
"service"
|
|
15
|
+
],
|
|
16
|
+
"summary": "Write Data",
|
|
17
|
+
"description": "Write data to a serial port device without waiting for response",
|
|
18
|
+
"parameters": [
|
|
19
|
+
{
|
|
20
|
+
"name": "data",
|
|
21
|
+
"summary": "Data to Write",
|
|
22
|
+
"required": true,
|
|
23
|
+
"description": "The data to write to the serial port (array of bytes or buffer)",
|
|
24
|
+
"schema": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"items": {
|
|
27
|
+
"type": "number"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "sleep",
|
|
33
|
+
"summary": "Sleep Duration",
|
|
34
|
+
"required": false,
|
|
35
|
+
"description": "Time to wait in milliseconds after writing (default: 1000)",
|
|
36
|
+
"schema": {
|
|
37
|
+
"type": "number",
|
|
38
|
+
"default": 1000
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "config",
|
|
43
|
+
"summary": "Serial Port Config",
|
|
44
|
+
"required": false,
|
|
45
|
+
"description": "Serial port configuration (optional, uses SERIALPORT_CONFIG from context if not provided)",
|
|
46
|
+
"schema": {
|
|
47
|
+
"type": "object"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
],
|
|
51
|
+
"responses": {
|
|
52
|
+
"200": {
|
|
53
|
+
"description": "Write operation completed successfully",
|
|
54
|
+
"content": {
|
|
55
|
+
"application/json": {
|
|
56
|
+
"schema": {
|
|
57
|
+
"type": "object",
|
|
58
|
+
"description": "Empty response object indicating successful write"
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"x-events": []
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"/command": {
|
|
68
|
+
"post": {
|
|
69
|
+
"tags": [
|
|
70
|
+
"service"
|
|
71
|
+
],
|
|
72
|
+
"summary": "Send Command",
|
|
73
|
+
"description": "Send a command to a serial port device and wait for response",
|
|
74
|
+
"parameters": [
|
|
75
|
+
{
|
|
76
|
+
"name": "data",
|
|
77
|
+
"summary": "Command Data",
|
|
78
|
+
"required": true,
|
|
79
|
+
"description": "The command data to send to the serial port (array of bytes or buffer)",
|
|
80
|
+
"schema": {
|
|
81
|
+
"type": "array",
|
|
82
|
+
"items": {
|
|
83
|
+
"type": "number"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "sleep",
|
|
89
|
+
"summary": "Sleep Duration",
|
|
90
|
+
"required": false,
|
|
91
|
+
"description": "Time to wait in milliseconds after sending command (default: 1000)",
|
|
92
|
+
"schema": {
|
|
93
|
+
"type": "number",
|
|
94
|
+
"default": 1000
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "timeout",
|
|
99
|
+
"summary": "Response Timeout",
|
|
100
|
+
"required": false,
|
|
101
|
+
"description": "Maximum time to wait for response in milliseconds (default: 3000)",
|
|
102
|
+
"schema": {
|
|
103
|
+
"type": "number",
|
|
104
|
+
"default": 3000
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "config",
|
|
109
|
+
"summary": "Serial Port Config",
|
|
110
|
+
"required": false,
|
|
111
|
+
"description": "Serial port configuration (optional, uses SERIALPORT_CONFIG from context if not provided)",
|
|
112
|
+
"schema": {
|
|
113
|
+
"type": "object"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
],
|
|
117
|
+
"responses": {
|
|
118
|
+
"200": {
|
|
119
|
+
"description": "Response data received from serial port device",
|
|
120
|
+
"content": {
|
|
121
|
+
"application/json": {
|
|
122
|
+
"schema": {
|
|
123
|
+
"type": "array",
|
|
124
|
+
"items": {
|
|
125
|
+
"type": "number"
|
|
126
|
+
},
|
|
127
|
+
"description": "Array of bytes received as response from the device"
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"x-events": []
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
"components": {
|
|
138
|
+
"schemas": {}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { PinsSettings } from '@digipair/engine';
|
|
2
|
+
export declare const write: (params: any, pinsSettingsList: PinsSettings[], context: any) => Promise<unknown>;
|
|
3
|
+
export declare const command: (params: any, pinsSettingsList: PinsSettings[], context: any) => Promise<unknown>;
|
|
4
|
+
//# sourceMappingURL=skill-serialport.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"skill-serialport.d.ts","sourceRoot":"","sources":["../../../src/lib/skill-serialport.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAuFhD,eAAO,MAAM,KAAK,GAAI,QAAQ,GAAG,EAAE,kBAAkB,YAAY,EAAE,EAAE,SAAS,GAAG,qBACf,CAAC;AAEnE,eAAO,MAAM,OAAO,GAAI,QAAQ,GAAG,EAAE,kBAAkB,YAAY,EAAE,EAAE,SAAS,GAAG,qBACf,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@digipair/skill-serialport",
|
|
3
|
+
"version": "0.131.8",
|
|
4
|
+
"main": "./dist/index.cjs.js",
|
|
5
|
+
"module": "./dist/index.esm.js",
|
|
6
|
+
"types": "./dist/index.d.ts",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"digipair",
|
|
9
|
+
"service",
|
|
10
|
+
"tool"
|
|
11
|
+
],
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"import": "./dist/index.esm.js",
|
|
16
|
+
"default": "./dist/index.cjs.js"
|
|
17
|
+
},
|
|
18
|
+
"./index.esm.js": "./dist/index.esm.js",
|
|
19
|
+
"./index.cjs.js": "./dist/index.cjs.js",
|
|
20
|
+
"./package.json": "./package.json",
|
|
21
|
+
"./schema.json": "./dist/schema.json",
|
|
22
|
+
"./schema.fr.json": "./dist/schema.fr.json"
|
|
23
|
+
},
|
|
24
|
+
"files": [
|
|
25
|
+
"dist",
|
|
26
|
+
"README.md",
|
|
27
|
+
"package.json"
|
|
28
|
+
],
|
|
29
|
+
"nx": {
|
|
30
|
+
"name": "skill-serialport"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"serialport": "13.0.0"
|
|
34
|
+
}
|
|
35
|
+
}
|