nRF52840 only: Module with types, definitions, and API used by the HID mouse class. More...
Modules | |
USB HID mouse descriptors | |
nRF52840 only: Module with types, definitions, and API used by the HID mouse class. | |
USB HID mouse configuration | |
USB HID mouse internals | |
nRF52840 only: Module with types, definitions, and API used by the HID mouse class. | |
Data Structures | |
struct | app_usbd_hid_mouse_t |
HID mouse class instance type. More... | |
Macros | |
#define | APP_USBD_HID_MOUSE_GLOBAL_DEF(instance_name,interface_number,endpoint,bcnt,user_ev_handler) |
Global definition of app_usbd_hid_mouse_t class. More... | |
Functions | |
static app_usbd_class_inst_t const * | app_usbd_hid_mouse_class_inst_get (app_usbd_hid_mouse_t const *p_mouse) |
Helper function to get class instance from HID mouse internals. More... | |
static app_usbd_hid_mouse_t const * | app_usbd_hid_mouse_class_get (app_usbd_class_inst_t const *p_inst) |
Helper function to get HID mouse from base class instance. More... | |
ret_code_t | app_usbd_hid_mouse_x_move (app_usbd_hid_mouse_t const *p_mouse, int8_t offset) |
Move mouse X axis. More... | |
ret_code_t | app_usbd_hid_mouse_y_move (app_usbd_hid_mouse_t const *p_mouse, int8_t offset) |
Move mouse Y axis. More... | |
ret_code_t | app_usbd_hid_mouse_scroll_move (app_usbd_hid_mouse_t const *p_mouse, int8_t offset) |
Move mouse scroll. More... | |
ret_code_t | app_usbd_hid_mouse_button_state (app_usbd_hid_mouse_t const *p_mouse, uint8_t button_id, bool state) |
Set mouse button state. More... | |
nRF52840 only: Module with types, definitions, and API used by the HID mouse class.
#define APP_USBD_HID_MOUSE_GLOBAL_DEF | ( | instance_name, | |
interface_number, | |||
endpoint, | |||
bcnt, | |||
user_ev_handler | |||
) |
Global definition of app_usbd_hid_mouse_t class.
instance_name | Name of global instance |
interface_number | Unique interface number |
endpoint | Input endpoint (nrf_drv_usbd_ep_t) |
bcnt | Mouse button count (from 1 to 8) |
user_ev_handler | User event handler (optional) |
ret_code_t app_usbd_hid_mouse_button_state | ( | app_usbd_hid_mouse_t const * | p_mouse, |
uint8_t | button_id, | ||
bool | state | ||
) |
Set mouse button state.
[in] | p_mouse | Mouse instance (declared by APP_USBD_HID_MOUSE_GLOBAL_DEF) |
[in] | button_id | Button number (0...7) |
[in] | state | Button state: true -> PRESSED, false -> RELEASED |
|
inlinestatic |
Helper function to get HID mouse from base class instance.
[in] | p_inst | Base class instance |
|
inlinestatic |
Helper function to get class instance from HID mouse internals.
[in] | p_mouse | Mouse instance (declared by APP_USBD_HID_MOUSE_GLOBAL_DEF) |
ret_code_t app_usbd_hid_mouse_scroll_move | ( | app_usbd_hid_mouse_t const * | p_mouse, |
int8_t | offset | ||
) |
Move mouse scroll.
[in] | p_mouse | Mouse instance (declared by APP_USBD_HID_MOUSE_GLOBAL_DEF) |
[in] | offset | Relative mouse position: allowed full int8_t range |
ret_code_t app_usbd_hid_mouse_x_move | ( | app_usbd_hid_mouse_t const * | p_mouse, |
int8_t | offset | ||
) |
Move mouse X axis.
[in] | p_mouse | Mouse instance (declared by APP_USBD_HID_MOUSE_GLOBAL_DEF) |
[in] | offset | Relative mouse position: allowed full int8_t range |
ret_code_t app_usbd_hid_mouse_y_move | ( | app_usbd_hid_mouse_t const * | p_mouse, |
int8_t | offset | ||
) |
Move mouse Y axis.
[in] | p_mouse | Mouse instance (declared by APP_USBD_HID_MOUSE_GLOBAL_DEF) |
[in] | offset | Relative mouse position: allowed full int8_t range |