Hank.peng: Created page with "= Definition = == Service Return Code ==

typedef enum {                                                             SV_ER_NOT_IMPLEMENT                = -13,   /*..."

2018-02-01T09:21:07Z

Created page with "= Definition = == Service Return Code == <pre>typedef enum { SV_ER_NOT_IMPLEMENT = -13, /*..."

New page

= Definition =

== Service Return Code ==
<pre>typedef enum {
SV_ER_NOT_IMPLEMENT = -13, /* Does Not Support this command (501) */
SV_ER_TIMEOUT = -12, /* Request Timeout (408) */
SV_ER_SYS_BUSY = -11, /* System is busy (503) */
SV_ER_VALUE_OUT_OF_RNAGE = -10, /* Value is out of range (416) */
SV_ER_SYNTAX_ERROR = -9, /* Format is correct but syntax error (422) */
SV_ER_FORMAT_ERROR = -8, /* Format error (415) */
SV_ER_REQUEST_ERROR = -7, /* Request error (400) */
SV_ER_RESOURCE_LOSE = -6, /* SenHub disconnect (410) */
SV_ER_RESOURCE_LOCKED = -5, /* Resource is in setting (426) */
SV_ER_NOT_FOUND = -4, /* Resource Not Found (404) */
SV_ER_WRITE_ONLY = -3, /* Read Only (405) */
SV_ER_READ_ONLY = -2, /* Write Only (405) */
SV_ER_FAILED = -1, /* Failed (500) */
SV_OK = 0, /* Success (200) */
SV_INITILIZED = 1, /* Library had initilized */
} SV_CODE;</pre>

== Service Status ==
<pre>typedef enum
{
SV_UNINIT = 0,
SV_INIT = 1,
SV_JOINED = 2,
SV_LEAVED = 3,
}SV_STATUS;</pre>

== Service Event ==

=== Callback Function ===
<pre>typedef SV_CODE (SVCALL *Service_Cb) ( SV_EVENT e, char *ServiceName, void *inData, int dataLen, void *pUserData )</pre>

=== Service Event Type ===
<pre>typedef enum
{
SV_E_JoinServiceSystem = 0, // Connected to the Service System
SV_E_LeaveServiceSystem = 1, // Disconnected from the Service System
SV_E_RegisterService = 2, // Registed a new Service ( ex: HDD_PMQ Plugin )
SV_E_DeregisterService = 3, // Deregisted a Service
SV_E_UpdateServiceCapability = 4, // Update Service's Capability
SV_E_UpdateData = 5, // Update Service's data value
SV_E_ActionResult = 6, // Reply Message of Get / Set
SV_E_EventNotify = 7, // EventNotify
}SV_EVENT;</pre>

=== '''Example''' ===

{| border="1" cellspacing="1" cellpadding="1" style="width: 1129px;"
|-
| style="width: 235px;" | '''e'''
| style="width: 161px;" | '''ServiceName'''
| style="width: 354px;" | '''inData'''
| style="width: 127px;" | '''dataLen'''
| style="width: 211px;" | '''pUserData'''
|-
| style="width: 235px;" | '''SV_E_JoinServiceSystem''' 
| style="width: 161px;" | ServiceSystem 
| style="width: 354px;" | ""
| style="width: 127px;" | 0
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_LeaveServiceSystem''' 
| style="width: 161px;" | ServiceSystem 
| style="width: 354px;" | ""
| style="width: 127px;" | 0
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_RegisterService''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | InfoSpec of Service refer to [[Agent_Communication_Protocol_in_MQTT#Info_or_Update_Device.27s_Capability|SenHub]] 
| style="width: 127px;" | Length of data 
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_DeregisterService''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | ""
| style="width: 127px;" | 0
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_UpdateServiceCapability''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | InfoSpec of Service refer to [[Agent_Communication_Protocol_in_MQTT#Info_or_Update_Device.27s_Capability|SenHub]] 
| style="width: 127px;" | Length of data 
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_UpdateData''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | data value of Service refer to [[Agent_Communication_Protocol_in_MQTT#Info_or_Update_Device.27s_Capability|SenHub]] 
| style="width: 127px;" | Length of data 
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_ActionResult''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | result of action 
| style="width: 127px;" | Length of data 
| style="width: 211px;" | point of user data 
|-
| style="width: 235px;" | '''SV_E_EventNotify''' 
| style="width: 161px;" | HDD_PMQ 
| style="width: 354px;" | event notify refer to [[Agent_Communication_Protocol_in_MQTT#EventNotify|EventNotify]] 
| style="width: 127px;" | Length of data 
| style="width: 211px;" | point of user data 
|}

''' '''

= Functions =

== Summary ==

{| border="1" cellspacing="1" cellpadding="1" style="width: 679px;"
|-
| style="width: 72px; text-align: center;" | Item
| style="width: 197px; text-align: center;" | Function Name
| style="width: 396px; text-align: center;" | Description
|-
| style="width: 72px; text-align: center;" | 1
| style="width: 197px;" | SV_Initialize
| style="width: 396px;" | Initialize the Service SDK 
|-
| style="width: 72px; text-align: center;" | 2
| style="width: 197px;" | SV_Uninitialize 
| style="width: 396px;" | UnInitialize the Service SDK 
|-
| style="width: 72px; text-align: center;" | 3
| style="width: 197px;" | SV_GetVersion 
| style="width: 396px;" | Get version of Service SDK 
|-
| style="width: 72px; text-align: center;" | 4
| style="width: 197px;" | SV_GetServiceStatus 
| style="width: 396px;" | Get status of Service System 
|-
| style="width: 72px; text-align: center;" | 5
| style="width: 197px;" | SV_Query_Service 
| style="width: 396px;" | Query All of Service Name 
|-
| style="width: 72px; text-align: center;" | 6
| style="width: 197px;" | SV_GetCapability 
| style="width: 396px;" | Get Service's Capability 
|-
| style="width: 72px; text-align: center;" | 7
| style="width: 197px;" | SV_AutoReportStart 
| style="width: 396px;" | Start Auto Report 
|-
| style="width: 72px; text-align: center;" | 8
| style="width: 197px;" | SV_AutoReportStop 
| style="width: 396px;" | Stop Auto Report 
|-
| style="width: 72px; text-align: center;" | 9
| style="width: 197px;" | SV_Action 
| style="width: 396px;" | Function for Get / Set Command 
|}

== Initial & Uninitial  ==

'''SV_CODE SV_Initialize( Service_Cb fn, void *pInUserData )'''

*'''Description:'''Initialize the Service SDK
*'''Parameter''':

           Service_Cb     fn: point of callback function

            void* pInUserData: user data will pass when callback

*'''Return value''':

           SV_CODE  - SV_OK                : Successful                                 SV_ER_FAILED  : Failed to call

*'''History''':   06/26/2017 Modified

'''SV_CODE SV_Uninitialize( );'''

*'''Description''': UnInitialize the Service SDK
*'''Parameter''': NONE
*'''Return value''':

           SV_CODE  - SV_OK                : Successful                                 SV_ER_FAILED  : Failed to call

*'''History''':   06/26/2017 Modified

== Information ==

'''SV_CODE SV_GetVersion(char *outVersion, int bufSize ); '''

*'''Description''': Get version of Service SDK
*'''Parameter''':

      - char * outVersion (out): point of result buffer size ( recomd: 128 bytes ) =>v1.0.1       - int    bufsize     (in): max size of buffer

*'''Return value''':

        SV_CODE  - SV_OK               : Successful                            - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
*'''Example''': 

                 '''outVersion''': "v1.0.1"

'''SV_STATUS SV_GetServiceStatus( );'''

*'''Description''': Get status of Service System
*'''Parameter''':

             NONE

*'''Return value:'''

                  SERVICE_STATUS - SV_UNINIT: SDK NOT Initilize                                                   - SV_INIT     : Init Status                                                   - SV_JOINED: Joined to Service System                                                   - SV_LEAVED: Leaved from Service System

*'''History''':   06/26/2017 Modified

'''SV_CODE SV_Query_Service( char *outBuf, int bufSize );'''

*'''Description''': Query All of Service Name
*'''Parameter''':

            - char * outBuf  (out):  point of result buffer size ( recomd: 1024 bytes ) => { "Service":{"e":[{"n":"HDD_PMQ},{"n":"Modebus"}] }

            - int     bufsize      (in):  max size of buffer

*'''Return value:'''

           SV_CODE  - SV_OK               : Successful                                - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
*'''Example:'''

'''              outBuf=> '''{"Service":{"e":[ ] }} or''' '''{"Service":{"e":[{"n":"HDD_PMQ},{"n":"Modebus"}]}}

== Function for Service ==

'''SV_CODE SV_GetCapability( const char *ServiceName, char *outBuffer,  int bufSize )'''

*'''Description''': Get Service's Capability
*'''Parameter''':

           - const char * ServiceName (in):    Service Name => HDD_PMQ

           - char *            outBuffer     (out):     buffer point for Service's Info Spec ( Recommend:4096 characters )

           - int                  bufSize            (in):     Max buffer size ( Recommend: 4096 ) 

*'''Return value:'''

           SV_CODE  - SV_OK               : Successful                                - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
*'''Example''':

            '''ServiceName''' : HDD_PMQ

'''             outBuffer ''': Capability of Serice refer to [[Agent_Communication_Protocol_in_MQTT#Info_or_Update_Device.27s_Capability|SenHub]]

'''SV_CODE SV_AutoReportStart( const char *ServiceName , char *inData, int inDataLen  );'''

*'''Description''': Start Auto Report
*'''Parameter''':

           - const char * ServiceName (in):    Service Name => HDD_PMQ

           - char *                      inData (in):     Start JSON Data

           - int                      inDataLen (in):     Data Length

*'''Return value:'''

           SV_CODE  - SV_OK               : Successful                                - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
<pre>{
"susiCommData":{
"requestID":1001,
"catalogID": 4,
"commCmd": 2053, //general_start_auto_upload_req
“handlerName”:”general”,
"requestItems":{"All":{}}
"autoUploadIntervalSec": 30
}
}</pre>

'''SV_CODE  SV_AutoReportStop( const char *ServiceName, char *inData, int inDataLen );'''

*'''Description''': Stop Auto Report
*'''Parameter''':

           - const char * ServiceName (in):    Service Name => HDD_PMQ

           - char *                      inData (in):     Start JSON Data

           - int                      inDataLen (in):     Data Length

*'''Return value:'''

           SV_CODE  - SV_OK               : Successful                                - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
*'''Example''':

            '''ServiceName''' : HDD_PMQ

'''             inData ''':
<pre> {
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd": 2056, //general_stop_auto_upload_req
“handlerName”:”general”
"requestItems":{"All":{}}
}
}</pre>

              ''' Reply:'''

                 Topic: /cagent/admin/<devID>/agentcallbackreq
<pre>{
"susiCommData":{
"requestID":1001,
"catalogID": 4,
"commCmd": 2054, //general_start_auto_upload_rep
“handlerName”:”general”,
“result”:”SUCCESS”
}
}</pre>

'''SV_CODE SV_Action( const char *ServiceName , char *szAction,  void *pUserData );'''

*'''Description''': Action function for Get / Set Command
*'''Parameter''':

           - const char * ServiceName (in) :    Service Name => HDD_PMQ

            - char *                     szAction (in) :    Action Command with JSON

            - void *                 pUserData ( in):    User data will return when result is callbacked

*'''Return value:'''

           SV_CODE  - SV_OK               : Successful                                - SV_ER_FAILED: Failed to call

*'''History''':   06/26/2017 Modified
*'''Example''':

            '''ServiceName''' : HDD_PMQ

'''             szAction''':
<pre>{
"susiCommData":{
"sessionID":"2746E3B65BAB115338B9668CDC5C35C4",
"sensorIDList":{
"e":[
{
"n":"SenHub/Info/sw"
}
]
},
"commCmd":523,
"requestID":0,
"agentID":"",
"handlerName":"SenHub",
"sendTS":1466057267
}
}</pre>

            ''' Reply: '''

                 '''Topic''': /cagent/admin/<devID>/agentactionreq
<pre>{
"susiCommData":{
"commCmd":524,
"handlerName":"SenHub",
"sessionID":"2746E3B65BAB115338B9668CDC5C35C4",
"sensorInfoList":{
"e":[
{
"n":"/Info/sw",
"sv":"1.0.00",
"StatusCode":200
}
]
}
}
}
</pre>

= Release & Sample Code =

{| border="1" cellspacing="1" cellpadding="1" style="width: 799px;"
|-
| style="width: 74px;" | Item
| style="width: 159px;" | Package Name
| style="width: 105px;" | Date
| style="width: 235px;" | Note
| style="width: 223px;" | Download ( Windows )
|-
| style="width: 74px;" | 1
| style="width: 159px;" | ServiceSDK_v1.0.1beta_20170704.zip 
| style="width: 105px;" | 2017/07/04
| style="width: 235px;" | initial beta release
| style="width: 223px;" | [[Media:ServiceSDK_v1.0.1beta_20170704.zip|v1.0.1_beta]]
|-
| style="width: 74px;" | 2
| style="width: 159px;" | EISServiceSDKSetup_1.0.3.zip 
| style="width: 105px;" | 2017/12/28
| style="width: 235px;" | 
| style="width: 223px;" | [[EISServiceSDKSetup_1.0.3.zip|v1.0.3]]
|}

EI Service SDK - Revision history

Hank.peng: Created page with "= Definition = == Service Return Code ==
typedef enum { SV_ER_NOT_IMPLEMENT = -13, /*..."