Types

API core data types. More...

Data Structures

struct  zos_buffer_t
 Generic data buffer type. More...
 

Typedefs

typedef uint8_t zos_bool_t
 boolean type
 
typedef void(* zos_stream_event_handler_t) (uint32_t handle)
 Data stream event handler prototype. More...
 

Enumerations

enum  zos_result_t {
  ZOS_SUCCESS = 0,
  ZOS_PENDING = 1,
  ZOS_TIMEOUT = 2,
  ZOS_ERROR = 4,
  ZOS_INVALID_ARG = 5,
  ZOS_UNSUPPORTED = 7,
  ZOS_NOTUP = 9,
  ZOS_NOT_FOUND = 12,
  ZOS_ABORTED = 17,
  ZOS_NOT_CONNECTED = 20,
  ZOS_INVALID_INTERFACE = 24,
  ZOS_NO_MEM = 32,
  ZOS_DECRYPT_ERROR = 42,
  ZOS_NO_CHANGE = 44,
  ZOS_NULL_PTR = 61,
  ZOS_UNINITIALIZED = 62,
  ZOS_NEVER_SET = 64,
  ZOS_SHUTTING_DOWN = 67,
  ZOS_INVALID_HEADER = 70,
  ZOS_HTTP_UNAUTHORIZED = 81,
  ZOS_HTTP_SERVER_ERROR = 82,
  ZOS_HTTP_NOT_FOUND = 83,
  ZOS_HTTP_BAD_REQUEST = 84,
  ZOS_NO_SSID = 85,
  ZOS_NO_PASSKEY = 86,
  ZOS_SEMAPHORE_ERROR = 1014,
  ZOS_WAIT_ABORTED = 1054,
  ZOS_QUEUE_MESSAGE_UNALIGNED = 1055,
  ZOS_UNIMPLEMENTED = 10000 ,
  ZOS_CMD_SUCCESS = 0,
  ZOS_CMD_FAILED = 10001,
  ZOS_CMD_PARSE_ERROR = 10002,
  ZOS_CMD_UNKNOWN = 10003,
  ZOS_CMD_TOO_FEW_ARGS = 10004,
  ZOS_CMD_TOO_MANY_ARGS = 10005,
  ZOS_CMD_UNKNOWN_OPTION = 10006,
  ZOS_CMD_BAD_ARGS = 10007,
  ZOS_CMD_BUFFER_OVERFLOW = 10008,
  ZOS_BUFFER_OVERFLOW = 10010,
  ZOS_DUPLICATE_EVENT = 10011,
  ZOS_BAD_EVENT_PERIOD = 10012,
  ZOS_NESTED_COMMAND = 10013,
  ZOS_NOT_SUBSCRIBED = 10014,
  ZOS_ZERO_LENGTH_BUFFER = 10015,
  ZOS_NO_DATA = 10016,
  ZOS_LOG_FILE_OVERFLOW = 10017,
  ZOS_INVALID_TOKEN = 10018,
  ZOS_WRITE_ERROR = 10020
}
 Result codes for API calls. More...
 
enum  {
  ZOS_FALSE = 0,
  ZOS_TRUE = 1
}
 
enum  zos_app_type_t { ZOS_APP_TYPE_DAEMON = 0 }
 ZentriOS application type. More...
 
enum  zos_app_flag_t {
  ZOS_APP_FLAG_NONE = (0 << 0),
  ZOS_APP_FLAG_SLEEP_ON_EXIT = (1 << 1),
  ZOS_APP_FLAG_DISABLE_CMD_CONSOLE = (1 << 3)
}
 ZentriOS application flags. More...
 
enum  zos_app_priority_t {
  ZOS_APP_PRIORITY_HIGHEST = 0,
  ZOS_APP_PRIORITY_HIGH = 1,
  ZOS_APP_PRIORITY_MEDIUM = 2,
  ZOS_APP_PRIORITY_LOW = 3,
  ZOS_APP_PRIORITY_LOWEST = 4
}
 ZentriOS application priority. More...
 

Detailed Description

API core data types.

Typedef Documentation

typedef void(* zos_stream_event_handler_t) (uint32_t handle)

Data stream event handler prototype.

Parameters
handleThe handle of the data stream

Enumeration Type Documentation

anonymous enum
Enumerator
ZOS_FALSE 

False value, zos_bool_t.

ZOS_TRUE 

True value, zos_bool_t.

ZentriOS application flags.

Enumerator
ZOS_APP_FLAG_NONE 

No flags, ZentriOS will reboot on app exit.

ZOS_APP_FLAG_SLEEP_ON_EXIT 

ZentriOS will sleep on app exit.

ZOS_APP_FLAG_DISABLE_CMD_CONSOLE 

Disable the ZentriOS serial command console.

ZentriOS application priority.

Enumerator
ZOS_APP_PRIORITY_HIGHEST 

ZOS_PRIORITY_HIGHEST.

ZOS_APP_PRIORITY_HIGH 

ZOS_PRIORITY_HIGH.

ZOS_APP_PRIORITY_MEDIUM 

ZOS_PRIORITY_MEDIUM.

ZOS_APP_PRIORITY_LOW 

ZOS_PRIORITY_LOW.

ZOS_APP_PRIORITY_LOWEST 

ZOS_PRIORITY_LOWEST.

ZentriOS application type.

Enumerator
ZOS_APP_TYPE_DAEMON 

Application runs as a background process.

Result codes for API calls.

Enumerator
ZOS_SUCCESS 

Complete successfully.

ZOS_PENDING 

Results still pending.

ZOS_TIMEOUT 

Timed-out waiting for result.

ZOS_ERROR 

Failed with general error.

ZOS_INVALID_ARG 

Invalid arg supplied to API call.

ZOS_UNSUPPORTED 

The given argument is not supported.

ZOS_NOTUP 

Interface is not currently Up.

ZOS_NOT_FOUND 

The requested argument is not found.

ZOS_ABORTED 

Aborted will executing.

ZOS_NOT_CONNECTED 

Not remotely connected.

ZOS_INVALID_INTERFACE 

The supplied interface is invalid (zos_interface_t )

ZOS_NO_MEM 

Out of Heap memory.

ZOS_DECRYPT_ERROR 

Error decrypting encrypted file/data.

ZOS_NO_CHANGE 

No change occurred from the previous call.

ZOS_NULL_PTR 

Supplied a null pointer as argument.

ZOS_UNINITIALIZED 

Attempting to use API without initializing first.

ZOS_NEVER_SET 

Failed to set variable first.

ZOS_SHUTTING_DOWN 

The ZAP or interface is shutdown.

ZOS_INVALID_HEADER 

Invalid header encountered.

ZOS_HTTP_UNAUTHORIZED 

HTTP server returned 403 response code.

ZOS_HTTP_SERVER_ERROR 

HTTP server returned 50x response code.

ZOS_HTTP_NOT_FOUND 

HTTP server returned 404 response code.

ZOS_HTTP_BAD_REQUEST 

HTTP server returned 400 response code.

ZOS_NO_SSID 

WLAN SSID (i.e. network name) not configured and required.

ZOS_NO_PASSKEY 

WLAN passowrd not configured and required.

ZOS_SEMAPHORE_ERROR 

Error while waiting for semaphore.

ZOS_WAIT_ABORTED 

Abort while waiting for semaphore, mutex, or other RTOS construct.

ZOS_QUEUE_MESSAGE_UNALIGNED 

Messages supplied to rtos queue api must be 32bit aligned.

ZOS_UNIMPLEMENTED 

The given API hasn't been implemented yet.

ZOS_CMD_SUCCESS 

The ZentriOS command completed successfully.

ZOS_CMD_FAILED 

The command failed, probably in the firmware somewhere.

ZOS_CMD_PARSE_ERROR 

Failed to parse the command.

ZOS_CMD_UNKNOWN 

Unknown command.

ZOS_CMD_TOO_FEW_ARGS 

Not enough command arguments.

ZOS_CMD_TOO_MANY_ARGS 

Too many command arguments.

ZOS_CMD_UNKNOWN_OPTION 

Unknown option (e.g. unknown 'set' command option)

ZOS_CMD_BAD_ARGS 

Invalid command arguments.

ZOS_CMD_BUFFER_OVERFLOW 

Serial command line buffer overflow.

ZOS_BUFFER_OVERFLOW 

A buffer overflowed.

ZOS_DUPLICATE_EVENT 

Attempting to issue event pointer/arg that is still waiting to execute.

ZOS_BAD_EVENT_PERIOD 

Failed to specify periodic event period.

ZOS_NESTED_COMMAND 

Can't call ZentriOS command from custom command.

ZOS_NOT_SUBSCRIBED 

Not subscribed to stream.

ZOS_ZERO_LENGTH_BUFFER 

Supplied buffer with now length.

ZOS_NO_DATA 

No data available.

ZOS_LOG_FILE_OVERFLOW 

Log file has no more room to append records.

ZOS_INVALID_TOKEN 

No valid token available which is needed for action.

ZOS_WRITE_ERROR 

Error while writing data.