# lv_monkey.h (/api/debugging/monkey/lv_monkey_h)



<RelatedHeaders name="lv_monkey_private.h" isPrivate="false" />

<ApiSummary functions="8" structs="3" typedefs="1" />

Functions [#functions]

<ApiTabs items="[&#x22;Setters (2)&#x22;,&#x22;Getters (3)&#x22;,&#x22;Other (3)&#x22;]">
  <ApiTab value="Setters (2)">
    <ApiMember kind="function" name="lv_monkey_set_enable" file="debugging/monkey/lv_monkey.h" line="80" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L80">
      lv_monkey_set_enable [#lv_monkey_set_enable]

      Enable monkey

      ```c title=" " lineNumbers=1
      void lv_monkey_set_enable(lv_monkey_t *monkey, bool en)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                   | Description           |
      | -------- | ------------------------------------------------------ | --------------------- |
      | `monkey` | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to a monkey   |
      | `en`     | <ApiLink name="bool" />                                | set to true to enable |
    </ApiMember>

    <ApiMember kind="function" name="lv_monkey_set_user_data" file="debugging/monkey/lv_monkey.h" line="94" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L94">
      lv_monkey_set_user_data [#lv_monkey_set_user_data]

      Set the user\_data field of the monkey

      ```c title=" " lineNumbers=1
      void lv_monkey_set_user_data(lv_monkey_t *monkey, void *user_data)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name        | Type                                                   | Description                    |
      | ----------- | ------------------------------------------------------ | ------------------------------ |
      | `monkey`    | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to a monkey            |
      | `user_data` | `void *`                                               | pointer to the new user\_data. |
    </ApiMember>
  </ApiTab>

  <ApiTab value="Getters (3)">
    <ApiMember kind="function" name="lv_monkey_get_indev" file="debugging/monkey/lv_monkey.h" line="73" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L73">
      lv_monkey_get_indev [#lv_monkey_get_indev]

      Get monkey input device

      ```c title=" " lineNumbers=1
      lv_indev_t * lv_monkey_get_indev(lv_monkey_t *monkey)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                   | Description         |
      | -------- | ------------------------------------------------------ | ------------------- |
      | `monkey` | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to a monkey |

      **Returns:** <ApiLink name="lv_indev_t" display="lv_indev_t *" /> — pointer to the input device
    </ApiMember>

    <ApiMember kind="function" name="lv_monkey_get_enable" file="debugging/monkey/lv_monkey.h" line="87" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L87">
      lv_monkey_get_enable [#lv_monkey_get_enable]

      Get whether monkey is enabled

      ```c title=" " lineNumbers=1
      bool lv_monkey_get_enable(lv_monkey_t *monkey)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                   | Description         |
      | -------- | ------------------------------------------------------ | ------------------- |
      | `monkey` | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to a monkey |

      **Returns:** <ApiLink name="bool" /> — return true if monkey enabled
    </ApiMember>

    <ApiMember kind="function" name="lv_monkey_get_user_data" file="debugging/monkey/lv_monkey.h" line="101" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L101">
      lv_monkey_get_user_data [#lv_monkey_get_user_data]

      Get the user\_data field of the monkey

      ```c title=" " lineNumbers=1
      void * lv_monkey_get_user_data(lv_monkey_t *monkey)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                   | Description         |
      | -------- | ------------------------------------------------------ | ------------------- |
      | `monkey` | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to a monkey |

      **Returns:** `void *` — the pointer to the user\_data of the monkey
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (3)">
    <ApiMember kind="function" name="lv_monkey_config_init" file="debugging/monkey/lv_monkey.h" line="59" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L59">
      lv_monkey_config_init [#lv_monkey_config_init]

      Initialize a monkey config with default values

      ```c title=" " lineNumbers=1
      void lv_monkey_config_init(lv_monkey_config_t *config)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                                 | Description                                               |
      | -------- | -------------------------------------------------------------------- | --------------------------------------------------------- |
      | `config` | <ApiLink name="lv_monkey_config_t" display="lv_monkey_config_t *" /> | pointer to 'lv\_monkey\_config\_t' variable to initialize |
    </ApiMember>

    <ApiMember kind="function" name="lv_monkey_create" file="debugging/monkey/lv_monkey.h" line="66" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L66">
      lv_monkey_create [#lv_monkey_create]

      Create monkey for test

      ```c title=" " lineNumbers=1
      lv_monkey_t * lv_monkey_create(const lv_monkey_config_t *config)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                                       | Description                                 |
      | -------- | -------------------------------------------------------------------------- | ------------------------------------------- |
      | `config` | <ApiLink name="lv_monkey_config_t" display="const lv_monkey_config_t *" /> | pointer to 'lv\_monkey\_config\_t' variable |

      **Returns:** <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> — pointer to the created monkey
    </ApiMember>

    <ApiMember kind="function" name="lv_monkey_delete" file="debugging/monkey/lv_monkey.h" line="107" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L107">
      lv_monkey_delete [#lv_monkey_delete]

      Delete monkey

      ```c title=" " lineNumbers=1
      void lv_monkey_delete(lv_monkey_t *monkey)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                                   | Description       |
      | -------- | ------------------------------------------------------ | ----------------- |
      | `monkey` | <ApiLink name="lv_monkey_t" display="lv_monkey_t *" /> | pointer to monkey |
    </ApiMember>
  </ApiTab>
</ApiTabs>

Structs [#structs]

<ApiMember kind="struct" name="lv_range_t">
  lv_range_t [#lv_range_t]

  | Member | Type                       | Description |
  | ------ | -------------------------- | ----------- |
  | `min`  | <ApiLink name="int32_t" /> |             |
  | `max`  | <ApiLink name="int32_t" /> |             |
</ApiMember>

<ApiMember kind="struct" name="lv_urange_t">
  lv_urange_t [#lv_urange_t]

  | Member | Type                        | Description |
  | ------ | --------------------------- | ----------- |
  | `min`  | <ApiLink name="uint32_t" /> |             |
  | `max`  | <ApiLink name="uint32_t" /> |             |
</ApiMember>

<ApiMember kind="struct" name="_lv_monkey_config_t">
  \_lv_monkey_config_t [#_lv_monkey_config_t]

  | Member         | Type                               | Description              |
  | -------------- | ---------------------------------- | ------------------------ |
  | `type`         | <ApiLink name="lv_indev_type_t" /> | Input device type        |
  | `period_range` | <ApiLink name="lv_urange_t" />     | Monkey execution period  |
  | `input_range`  | <ApiLink name="lv_range_t" />      | The range of input value |
</ApiMember>

Typedefs [#typedefs]

<ApiMember kind="typedef" name="lv_monkey_t" file="debugging/monkey/lv_monkey.h" line="28" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/debugging/monkey/lv_monkey.h#L28">
  lv_monkey_t [#lv_monkey_t]

  ```c title=" " lineNumbers=1
  typedef struct _lv_monkey_t lv_monkey_t
  ```
</ApiMember>

<TypeUsedBy name="lv_monkey_t" count="6">
  * `lv_monkey_get_indev` — param `monkey`
  * `lv_monkey_set_enable` — param `monkey`
  * `lv_monkey_get_enable` — param `monkey`
  * `lv_monkey_set_user_data` — param `monkey`
  * `lv_monkey_get_user_data` — param `monkey`
  * `lv_monkey_delete` — param `monkey`
</TypeUsedBy>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_conf_internal.h&#x22;, &#x22;lv_indev.h&#x22;]" includedBy="[&#x22;lv_monkey_private.h&#x22;]" transitiveIncludes="[&#x22;lv_area.h&#x22;, &#x22;lv_array.h&#x22;, &#x22;lv_conf_kconfig.h&#x22;, &#x22;lv_event.h&#x22;, &#x22;lv_group.h&#x22;, &#x22;lv_ll.h&#x22;, &#x22;lv_math.h&#x22;, &#x22;lv_tick.h&#x22;, &#x22;lv_timer.h&#x22;, &#x22;lv_types.h&#x22;]" />