pixy2_protocol.h

Go to the documentation of this file.

/*
 * Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef _PIXY2_PROTOCOL_H_
#define _PIXY2_PROTOCOL_H_
 
#include "pixy2_transport.h"
 
#define PIXY2_REQUEST_GET_VERSION       0xe
#define PIXY2_REQUEST_SET_LED           0x14
#define PIXY2_REQUEST_SET_LAMP          0x16
#define PIXY2_REQUEST_GET_MAIN_FEATURES     0x30
 
#define PIXY2_REPLY_GET_VERSION         0xf
#define PIXY2_REPLY_SET_LED         0x1
#define PIXY2_REPLY_SET_LAMP            0x1
#define PIXY2_REPLY_GET_MAIN_FEATURES       0x31
#define PIXY2_REPLY_ERROR           0x3
 
#define PIXY2_OK                0
#define PIXY2_ERROR             -1
#define PIXY2_BUSY              -2
#define PIXY2_CHECKSUM_ERROR            -3
#define PIXY2_TIMEOUT               -4
#define PIXY2_BUTTON_OVERRIDE           -5
#define PIXY2_PROG_CHANGING         -6
 
#define PIXY2_REQUEST_SYNC0_NO_CHECKSUM     0xae
#define PIXY2_REQUEST_SYNC1_NO_CHECKSUM     0xc1
#define PIXY2_REQUEST_SYNC0_CHECKSUM        0xaf
#define PIXY2_REQUEST_SYNC1_CHECKSUM        0xc1
 
#define PIXY2_REPLY_SYNC0           0xaf
#define PIXY2_REPLY_SYNC1           0xc1
 
#define PIXY2_REQUEST_SYNC0(checksum)                   \
    ((checksum) ?                           \
     PIXY2_REQUEST_SYNC0_CHECKSUM : PIXY2_REQUEST_SYNC0_NO_CHECKSUM)
 
#define PIXY2_REQUEST_SYNC1(checksum)                   \
    ((checksum) ?                           \
     PIXY2_REQUEST_SYNC1_CHECKSUM : PIXY2_REQUEST_SYNC1_NO_CHECKSUM)
 
int pixy2_to_errno(int32_t result);
 
int pixy2_protocol_transceive(struct pixy2_transport *t,
                  struct pixy2_message *req,
                  struct pixy2_message *reply);
 
#endif /* _PIXY2_PROTOCOL_H_ */