libmcm  1.4.0
A client library for Moxa Connection Management
mcm-base-info.h File Reference
#include <inttypes.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  mcm_object_info
 
struct  mcm_property_info
 
struct  mcm_property_info_linked_list
 
struct  mcm_interface_info
 
struct  mcm_network_info
 
struct  mcm_network_status
 
struct  mcm_ethernet_info
 
struct  mcm_wifi_info
 
struct  mcm_modem_info
 
struct  mcm_wifi_ap
 
struct  mcm_profiles
 
struct  mcm_datausage_info
 
struct  mcm_diag_info
 
struct  mcm_upgrade_info
 

Typedefs

typedef struct mcm_object_info mcm_object_info
 
typedef struct mcm_property_info mcm_property_info
 
typedef struct mcm_property_info_linked_list mcm_property_info_linked_list
 
typedef struct mcm_interface_info mcm_interface_info
 
typedef struct mcm_network_info mcm_network_info
 
typedef struct mcm_network_status mcm_network_status
 
typedef struct mcm_ethernet_info mcm_ethernet_info
 
typedef struct mcm_wifi_info mcm_wifi_info
 
typedef struct mcm_modem_info mcm_modem_info
 
typedef struct mcm_wifi_ap mcm_wifi_ap
 
typedef struct mcm_profiles mcm_profiles
 
typedef struct mcm_datausage_info mcm_datausage_info
 
typedef struct mcm_diag_info mcm_diag_info
 
typedef struct mcm_upgrade_info mcm_upgrade_info
 

Enumerations

enum  MCM_ERROR_CODE {
  MCM_SUCCESS = 0 , MCM_GENERIC_ERR = 1 , MCM_ENOMEM = 2 , MCM_ENODEV = 3 ,
  MCM_EINVAL = 4
}
 

Functions

struct mcm_property_info __attribute__ ((packed))
 
void mcm_free_property_info (int arr_len, mcm_property_info *info)
 A help function for properies array free. More...
 
char * mcm_get_error_message (int error_num)
 A help function for propertyInfo_sub appended to propertyInfo. More...
 

Variables

char * propertyName
 
char * propertyValue
 
struct mcm_property_info_linked_listnext
 
char interface_name [64]
 
char device_name [16]
 
char device_type [16]
 
bool enabled
 
uint32_t wan_priority
 
char name [64]
 
char network_ifname [16]
 
char network_type [16]
 
char ipv4_method [16]
 
char ipv6_method [16]
 
char mac_address [64]
 
char err_reason [200]
 
bool default_route
 
char ipv4_address [16]
 
char ipv4_netmask [16]
 
char ipv4_gateway [16]
 
char ipv4_dns [2][16]
 
char ipv6_address [64]
 
char ipv6_netmask [64]
 
char ipv6_gateway [64]
 
char ipv6_dns [2][64]
 
uint32_t connection_status
 
bool link_detected
 
uint32_t link_speed
 
char duplex [16]
 
bool dhcp_server
 
char bssid [32]
 
char hwmode [16]
 
char frequency [16]
 
char operation_mode [16]
 
char ssid [40]
 
char secure_mode [16]
 
char signal [16]
 
uint32_t channel
 
bool broadcast
 
char cell_id [16]
 
char device_imei [16]
 
char network_rat [16]
 
char operator[32]
 
char sim_iccid [32]
 
char sim_imsi [16]
 
char apn [32]
 
char taclac [16]
 
int32_t pin_retries
 
uint32_t signal_strength
 
uint32_t sim_slot
 
int32_t modem_state
 
char modem_name [64]
 
char modem_version [64]
 
int32_t umts_rssi
 
int32_t umts_ecio
 
int32_t lte_rsrp
 
int32_t lte_rssnr
 
int32_t nr_rsrp
 
int32_t nr_snr
 
char encryption_type [32]
 
int32_t rssi
 
char profile_name [32]
 
uint32_t tx
 
uint32_t rx
 
uint32_t diag_state
 
char message [512]
 
uint32_t state
 

Detailed Description

This library is for Moxa Connection Management

Author
York LY Chang YorkL.nosp@m.Y.Ch.nosp@m.ang@m.nosp@m.oxa..nosp@m.com

Enumeration Type Documentation

◆ MCM_ERROR_CODE

MCM Error Number

Enumerator
MCM_SUCCESS 

success

MCM_GENERIC_ERR 

Generic error

MCM_ENOMEM 

Allocate memory fail

MCM_ENODEV 

No such device

MCM_EINVAL 

Invalid argument

Function Documentation

◆ mcm_free_property_info()

void mcm_free_property_info ( int  arr_len,
mcm_property_info info 
)

A help function for properies array free.

Parameters
arr_len(input) A number of properties array.
info(input) A properies array being to free.

◆ mcm_get_error_message()

char* mcm_get_error_message ( int  error_num)

A help function for propertyInfo_sub appended to propertyInfo.

Parameters
error_num(input) A error number.
Returns
error message.

Variable Documentation

◆ apn

char apn[32]

apn

◆ broadcast

bool broadcast

broadcast

◆ bssid

char bssid

BSSID

bssid

◆ cell_id

char cell_id[16]

cell id

◆ channel

uint32_t channel

channel

◆ connection_status

uint32_t connection_status

connection status (Indexed by McmConnectionState)

◆ default_route

bool default_route

default route

◆ device_imei

char device_imei[16]

device imei

◆ device_name

char device_name

device name

◆ device_type

char device_type

device type

◆ dhcp_server

bool dhcp_server

DHCP Server status

◆ diag_state

uint32_t diag_state

diag bitmask state

◆ duplex

char duplex[16]

duplex

◆ enabled

bool enabled

enabled

◆ encryption_type

char encryption_type[32]

encryption type

◆ err_reason

char err_reason[200]

error reason

◆ frequency

char frequency

is 2.4g/5g

freqency

◆ hwmode

char hwmode[16]

hwmode

◆ interface_name

char interface_name[64]

interface name

◆ ipv4_address

char ipv4_address[16]

ipv4 address

◆ ipv4_dns

char ipv4_dns[2][16]

ipv4 DNS

◆ ipv4_gateway

char ipv4_gateway[16]

ipv4 gateway

◆ ipv4_method

char ipv4_method[16]

ipv4 method

◆ ipv4_netmask

char ipv4_netmask[16]

ipv4 netmask

◆ ipv6_address

char ipv6_address[64]

ipv6 address

◆ ipv6_dns

char ipv6_dns[2][64]

ipv6 DNS

◆ ipv6_gateway

char ipv6_gateway[64]

ipv6 gateway

◆ ipv6_method

char ipv6_method[16]

ipv6 method

◆ ipv6_netmask

char ipv6_netmask[64]

ipv6 netmask

◆ link_detected

bool link_detected

link detected

◆ link_speed

uint32_t link_speed

link speed

◆ lte_rsrp

int32_t lte_rsrp

4G RSRP

◆ lte_rssnr

int32_t lte_rssnr

4G RSSNR

◆ mac_address

char mac_address[64]

mac address

◆ message

char message

diag message

upgrade message

◆ modem_name

char modem_name[64]

modem name

◆ modem_state

int32_t modem_state

modem state (Indexed by McmModemState)

◆ modem_version

char modem_version[64]

modem FWR version

◆ name

char name[64]

name

◆ network_ifname

char network_ifname[16]

network ifname

◆ network_rat

char network_rat[16]

network rat

◆ network_type

char network_type[16]

network type

◆ next

linked-list

◆ nr_rsrp

int32_t nr_rsrp

5G RSRP

◆ nr_snr

int32_t nr_snr

5G SNR

◆ operation_mode

char operation_mode[16]

operation mode

◆ operator[32]

char operator[32]

operator

◆ pin_retries

int32_t pin_retries

pin retries

◆ profile_name

char profile_name[32]

profile name

◆ propertyName

char * propertyName

property name

◆ propertyValue

char * propertyValue

property value

◆ rssi

int32_t rssi

rssi

◆ rx

uint32_t rx

RX Bytes

◆ secure_mode

char secure_mode[16]

scure mode

◆ signal

char signal[16]

signal

◆ signal_strength

uint32_t signal_strength

signal strength

◆ sim_iccid

char sim_iccid[32]

sim iccid

◆ sim_imsi

char sim_imsi[16]

sim imsi

◆ sim_slot

uint32_t sim_slot

sim slot

◆ ssid

char ssid

SSID

ssid

◆ state

uint32_t state

upgrade bitmask state

◆ taclac

char taclac[16]

taclac

◆ tx

uint32_t tx

TX Bytes

◆ umts_ecio

int32_t umts_ecio

3G RSRP

◆ umts_rssi

int32_t umts_rssi

3G RSSI

◆ wan_priority

uint32_t wan_priority

wan priority