client_manager.h

/* Copyright Statement:
 *
 * This software/firmware and related documentation ("Fishsemi Software") are
 * protected under relevant copyright laws. The information contained herein is
 * confidential and proprietary to Fishsemi Inc. and/or its licensors. Without
 * the prior written permission of Fishsemi inc. and/or its licensors, any
 * reproduction, modification, use or disclosure of Fishsemi Software, and
 * information contained herein, in whole or in part, shall be strictly
 * prohibited.
 *
 * Fishsemi Inc. (C) 2019. All rights reserved.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("PINECONE SOFTWARE")
 * RECEIVED FROM PINECONE AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
 * ON AN "AS-IS" BASIS ONLY. PINECONE EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES PINECONE PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH THE PINECONE SOFTWARE, AND RECEIVER AGREES
 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN PINECONE
 * SOFTWARE. PINECONE SHALL ALSO NOT BE RESPONSIBLE FOR ANY PINECONE SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND PINECONE'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE PINECONE SOFTWARE
 * RELEASED HEREUNDER WILL BE, AT PINECONE'S OPTION, TO REVISE OR REPLACE THE
 * PINECONE SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
 * CHARGE PAID BY RECEIVER TO PINECONE FOR SUCH PINECONE SOFTWARE AT ISSUE.
 *
 * The following software/firmware and/or related documentation ("Fishsemi
 * Software") have been modified by Fishsemi Inc. All revisions are subject to
 * any receiver's applicable license agreements with Fishsemi Inc.
 */

#ifndef __CLIENT_MANAGER_H__
#define __CLIENT_MANAGER_H__

#include "utils.h"
#include "sensor.h"

struct snshub_client;

struct cmgr_callback {
  void (*event_update)(struct sensor_event *event, size_t num);
  void (*accuracy_changed)(struct snshub_sensor_t *sensor, int accuracy);
};

uint32_t cmgr_get_version(void);
bool cmgr_system_ready(void);
struct snshub_client *cmgr_client_request(const char *name, struct cmgr_callback *cb);
int cmgr_client_release(struct snshub_client *client);

int cmgr_get_num_of_sensors(void);
int cmgr_get_all_handles(int *handles);

struct snshub_sensor_t *cmgr_get_sensor_by_type(int type);
struct snshub_sensor_t *cmgr_get_sensor_by_handle(int handle);

int cmgr_activate_sensor(struct snshub_client *client, struct snshub_sensor_t *sensor, bool enable, snshub_data_mode mode);
int cmgr_set_delay(struct snshub_client *client, struct snshub_sensor_t *sensor, uint32_t delay);
int cmgr_read_data(struct snshub_client *client, struct snshub_sensor_t *sensor, struct sensor_event *event);

/* this combo api is mainly used by the local application running inside the sensorhub.
 * sensor: for which to enable/disable, NULL for all sensors of this client if enable is false
 * delay: the output delay in us, ignored if enable is false */
int cmgr_activate_sensor_one(struct snshub_client *client, struct snshub_sensor_t *sensor, uint32_t delay, bool enable, snshub_data_mode mode);

#endif