Skip to content

Commit a5153f7

Browse files
committed
docs: halmodule document missing function
1 parent eeed984 commit a5153f7

1 file changed

Lines changed: 25 additions & 16 deletions

File tree

docs/src/hal/halmodule.adoc

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ Get the current Realtime msg level.
199199

200200
=== set_msg_level
201201

202-
set the current Realtime msg level. +
202+
Set the current Realtime msg level. +
203203
used for debugging information.
204204

205205
=== connect
@@ -211,9 +211,18 @@ Example:
211211
hal.connect("pinname","signal_name")
212212
----
213213

214+
=== disconnect
215+
216+
Disonnect a pin from a signal. +
217+
Example:
218+
219+
----
220+
hal.disconnect("pinname")
221+
----
222+
214223
=== get_value
215224

216-
read a pin, param or signal directly. +
225+
Read a pin, param, or signal directly. +
217226
Example:
218227

219228
----
@@ -222,7 +231,7 @@ value = hal.get_value("iocontrol.0.emc-enable-in")
222231

223232
=== get_info_pins()
224233

225-
returns a list of dicts of all system pins.
234+
Returns a list of dicts of all system pins.
226235

227236
[source,python]
228237
----
@@ -235,7 +244,7 @@ pinDirection1 = listOfDicts[0].get('DIRECTION')
235244

236245
=== get_info_signals()
237246

238-
returns a list of dicts of all system signals.
247+
Returns a list of dicts of all system signals.
239248

240249
[source,python]
241250
----
@@ -247,7 +256,7 @@ driverPin1 = listOfDicts[0].get('DRIVER')
247256

248257
=== get_info_params()
249258

250-
returns a list of dicts of all system parameters.
259+
Returns a list of dicts of all system parameters.
251260

252261
[source,python]
253262
----
@@ -257,9 +266,9 @@ paramValue1 = listOfDicts[0].get('VALUE')
257266
paramDirection1 = listOfDicts[0].get('DIRECTION')
258267
----
259268

260-
=== new_signal
269+
=== new_sig
261270

262-
Create a New signal of the type specified. +
271+
Create a new signal of the type specified. +
263272
Example:
264273

265274
----
@@ -277,42 +286,42 @@ h.in.pin_has_writer()
277286

278287
=== get_name
279288

280-
Get the HAL object name +
281-
return a string
289+
Get the HAL object name. +
290+
Return a string.
282291

283292
----
284293
h.in.get_name()
285294
----
286295

287296
=== get_type
288297

289-
Get the HAL object's type +
290-
returns an integer
298+
Get the HAL object's type. +
299+
Returns an integer.
291300

292301
----
293302
h.in.get_type()
294303
----
295304

296305
=== get_dir
297306

298-
Get the HAL object direction type +
299-
returns an integer
307+
Get the HAL object direction type. +
308+
Returns an integer.
300309

301310
----
302311
h.in.get_dir()
303312
----
304313

305314
=== get
306315

307-
get the HAL object value
316+
Get the HAL object value.
308317

309318
----
310319
h.in.get()
311320
----
312321

313322
=== set
314323

315-
set the HAL object value
324+
Set the HAL object value.
316325

317326
----
318327
h.out.set(10)
@@ -321,7 +330,7 @@ h.out.set(10)
321330
=== is_pin
322331

323332
Is the object a pin or parameter? +
324-
returns bool
333+
Returns True or False.
325334

326335
----
327336
h.in.is_pin()

0 commit comments

Comments
 (0)