Imported Upstream version 1.0.0
[platform/upstream/iotivity.git] / resource / csdk / connectivity / src / bt_le_adapter / arduino / cableserver.h
index df0750a..f95fcbe 100644 (file)
@@ -1,22 +1,22 @@
 /* ****************************************************************
-*
-* Copyright 2014 Samsung Electronics All Rights Reserved.
-*
-*
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-******************************************************************/
+ *
+ * Copyright 2014 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 /**
  * @file
@@ -24,7 +24,7 @@
  * This file contains the APIs related to the GATT Server functionalities.
  * Creation of the GATT Server with the characteristics. Enabling the
  * advertisement and updating the characteristics for the response and
- * notifying the change of characteristcs for the request will be done here.
+ * notifying the change of characteristics for the request will be done here.
  */
 
 #ifndef BLE_ADAPTER_ARDUINO_H_
@@ -39,32 +39,32 @@ extern "C"
 #endif
 
 /**
- * @brief API to initialize Arduino BLE module and advertise the service
- * @return #CA_STATUS_OK or Appropriate error code
+ * API to initialize Arduino BLE module and advertise the service.
+ * @return ::CA_STATUS_OK or Appropriate error code.
  */
 CAResult_t CALEInitialize();
 
 /**
- * @brief API to check whether data is available in BLE shield
- * @return - Received buffer length
+ * API to check whether data is available in BLE shield.
+ * @return - Received buffer length.
  */
 unsigned char CAIsLEDataAvailable();
 
 /**
- * @brief API to check whether client is connected with BLE Shield
- * @return - Connection state
+ * API to check whether client is connected with BLE Shield.
+ * @return - Connection state.
  */
 unsigned char CAIsLEConnected();
 
 /**
- * @brief API to read data from BLE shield
- * @return - Data read
+ * API to read data from BLE shield.
+ * @return - Data read.
  */
-char CALEReadData();
+uint8_t CALEReadData();
 
 /**
- * @brief API to perform BLE events
- * @return #CA_STATUS_OK or Appropriate error code
+ * API to perform BLE events.
+ * @return ::CA_STATUS_OK or Appropriate error code.
  */
 CAResult_t CALEDoEvents();