dm_lua_api_register Function

public function dm_lua_api_register(lua, errors, log_levels, procedures, response_types, modbus_types) result(rc)

Uses

  • proc~~dm_lua_api_register~~UsesGraph proc~dm_lua_api_register dm_lua_api_register module~dm_log dm_log proc~dm_lua_api_register->module~dm_log module~dm_modbus_type dm_modbus_type proc~dm_lua_api_register->module~dm_modbus_type module~dm_response dm_response proc~dm_lua_api_register->module~dm_response module~dm_error dm_error module~dm_log->module~dm_error module~dm_id dm_id module~dm_log->module~dm_id module~dm_kind dm_kind module~dm_log->module~dm_kind module~dm_node dm_node module~dm_log->module~dm_node module~dm_observ dm_observ module~dm_log->module~dm_observ module~dm_sensor dm_sensor module~dm_log->module~dm_sensor module~dm_target dm_target module~dm_log->module~dm_target module~dm_time dm_time module~dm_log->module~dm_time module~dm_uuid dm_uuid module~dm_log->module~dm_uuid module~dm_modbus_type->module~dm_response module~dm_modbus_type->module~dm_error module~dm_modbus_type->module~dm_kind module~dm_string dm_string module~dm_modbus_type->module~dm_string module~dm_response->module~dm_error module~dm_response->module~dm_id module~dm_response->module~dm_kind module~dm_util dm_util module~dm_response->module~dm_util module~dm_error->module~dm_kind module~dm_ascii dm_ascii module~dm_error->module~dm_ascii iso_fortran_env iso_fortran_env module~dm_kind->iso_fortran_env module~dm_node->module~dm_id module~dm_node->module~dm_kind module~dm_observ->module~dm_response module~dm_observ->module~dm_error module~dm_observ->module~dm_id module~dm_observ->module~dm_kind module~dm_observ->module~dm_node module~dm_observ->module~dm_sensor module~dm_observ->module~dm_target module~dm_observ->module~dm_time module~dm_observ->module~dm_util module~dm_observ->module~dm_uuid module~dm_request dm_request module~dm_observ->module~dm_request module~dm_sensor->module~dm_id module~dm_sensor->module~dm_kind module~dm_sensor->module~dm_node module~dm_string->module~dm_error module~dm_string->module~dm_kind module~dm_target->module~dm_id module~dm_target->module~dm_kind module~dm_target->module~dm_util module~dm_time->module~dm_error module~dm_time->module~dm_kind module~dm_time->module~dm_util unix unix module~dm_time->unix module~dm_util->module~dm_error module~dm_util->module~dm_kind module~dm_request->module~dm_response module~dm_request->module~dm_error module~dm_request->module~dm_id module~dm_request->module~dm_kind module~dm_request->module~dm_time module~dm_request->module~dm_util

This function exports parameters and procedures of the DMPACK API to the given Lua environment lua.

By default, all parameters and procedures are registered. The export of error codes, log levels, and procedures may be disabled through the dummy arguments.

All DMPACK error codes are exported, starting from E_NONE, if errors is not .false..

The following log level parameters are injected if log_levels is not .false.:

  • LL_NONE
  • LL_DEBUG
  • LL_INFO
  • LL_WARNING
  • LL_ERROR
  • LL_CRITICAL
  • LL_USER

The following Lua procedures are registered if procedures is not .false.:

  • deg2gon(deg)
  • deg2rad(deg)
  • gon2deg(gon)
  • gon2rad(gon)
  • rad2deg(rad)
  • rad2gon(rad)

The following response type parameters are injected if response_types is not .false.:

  • RESPONSE_TYPE_REAL64
  • RESPONSE_TYPE_REAL32
  • RESPONSE_TYPE_INT64
  • RESPONSE_TYPE_INT32
  • RESPONSE_TYPE_LOGICAL
  • RESPONSE_TYPE_BYTE
  • RESPONSE_TYPE_STRING

The following Modbus type parameters are injected if modbus_types is .true.:

  • MODBUS_ACCESS_NONE
  • MODBUS_ACCESS_READ

  • MODBUS_ACCESS_WRITE

  • MODBUS_TYPE_NONE

  • MODBUS_TYPE_INT16
  • MODBUS_TYPE_INT32
  • MODBUS_TYPE_UINT16
  • MODBUS_TYPE_UINT32

  • MODBUS_TYPE_FLOAT

  • MODBUS_ORDER_NONE

  • MODBUS_ORDER_ABCD
  • MODBUS_ORDER_BADC
  • MODBUS_ORDER_CDAB
  • MODBUS_ORDER_DCBA

The GeoCOM API is registered through function dm_lua_geocom_register() in module dm_lua_geocom.

This function returns E_INVALID if the Lua interpreter has not been initialised, or E_LUA if the registration failed.

Arguments

Type IntentOptional Attributes Name
type(lua_state_type), intent(inout) :: lua

Lua state type.
logical, intent(in), optional :: errors

Export error codes.
logical, intent(in), optional :: log_levels

Export log level.
logical, intent(in), optional :: procedures

Export procedures.
logical, intent(in), optional :: response_types

Export response type parameters.
logical, intent(in), optional :: modbus_types

Export Modbus type parameters.

Return Value integer


Calls

proc~~dm_lua_api_register~~CallsGraph proc~dm_lua_api_register dm_lua_api_register interface~dm_lua_set dm_lua_set proc~dm_lua_api_register->interface~dm_lua_set interface~dm_present dm_present proc~dm_lua_api_register->interface~dm_present proc~dm_is_error dm_is_error proc~dm_lua_api_register->proc~dm_is_error proc~dm_lua_is_opened dm_lua_is_opened proc~dm_lua_api_register->proc~dm_lua_is_opened proc~dm_lua_register dm_lua_register proc~dm_lua_api_register->proc~dm_lua_register lua_register lua_register proc~dm_lua_register->lua_register

Called by

proc~~dm_lua_api_register~~CalledByGraph proc~dm_lua_api_register dm_lua_api_register proc~dm_config_open dm_config_open proc~dm_config_open->proc~dm_lua_api_register proc~luaopen_libdmpack luaopen_libdmpack proc~luaopen_libdmpack->proc~dm_lua_api_register