From 662d41cab204fc90a6789358ca3adb0a1f2bd4d8 Mon Sep 17 00:00:00 2001 From: "Pavel A." Date: Mon, 12 Jan 2015 03:10:33 +0200 Subject: [PATCH] Update Readme_USB-Relay-DLL.md --- doc/Readme_USB-Relay-DLL.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/Readme_USB-Relay-DLL.md b/doc/Readme_USB-Relay-DLL.md index 7ba98e3..ce7888b 100644 --- a/doc/Readme_USB-Relay-DLL.md +++ b/doc/Readme_USB-Relay-DLL.md @@ -28,50 +28,50 @@ The DLL may require VC++ redistributable runtime library. Using the API: -------------- - * usb_relay_init() + * `usb_relay_init()` Call this before calling other functions - * usb_relay_device_enumerate() + * `usb_relay_device_enumerate` Enumerates all Relay devices plugged into the PC. Returns list of usb_relay_device_info structures. Caller should free this list by passing it to usb_relay_device_free_enumerate(). - * usb_relay_device_open() + * `usb_relay_device_open` Opens one Relay board device by its usb_relay_device_info structure, obtained from usb_relay_device_enumerate(). - * usb_relay_device_open_with_serial_number + * `usb_relay_device_open_with_serial_number` Opens one Relay board device by its serial number string. These strings can be obtained from usb_relay_device_enumerate(). - * usb_relay_device_open_one_relay_channel + * `usb_relay_device_open_one_relay_channel` Turns ON one channel of a Relay board. Parameters: - device handle, obtained from usb_relay_device_open() - Index: integer from 1 to the maximal number of channels on a board. - * usb_relay_device_open_all_relay_channel + * `usb_relay_device_open_all_relay_channel` Turns ON all channels on a board. - * usb_relay_device_close_one_relay_channel + * `usb_relay_device_close_one_relay_channel` Turns OFF one channel of a Relay board. Parameters: - - device handle, obtained from usb_relay_device_open() + - device handle, obtained from `usb_relay_device_open()` - Index: integer from 1 to the maximal number of channels on a board. - * usb_relay_device_close_all_relay_channel() + * `usb_relay_device_close_all_relay_channel` Turns OFF all channels on a board. - * usb_relay_device_get_status + * `usb_relay_device_get_status` Get status of all channels on a board as a bit mask. The least significant bit in returned value corresponds to channel 1. Bit value 1 means the corresponding relay is switched ON, value 0 means the relay is OFF. - * usb_relay_device_close - Closes the Relay device handle opened by usb_relay_device_open() or - usb_relay_device_open_with_serial_number() + * `usb_relay_device_close` + Closes the Relay device handle opened by `usb_relay_device_open()` or + `usb_relay_device_open_with_serial_number()` - * usb_relay_exit +* `usb_relay_exit` Finalizes the library Error handling -- 2.25.1