add some code
This commit is contained in:
@@ -0,0 +1 @@
|
||||
c5da844e73ab7b7e02938901e71f38deed94b26976045fb4517e7fc1e8dc4db5
|
||||
@@ -0,0 +1 @@
|
||||
{"version": "1.0", "algorithm": "sha256", "created_at": "2025-05-23T10:05:30.458691+00:00", "files": [{"path": "CMakeLists.txt", "size": 97, "hash": "060350424e73ef66961714eaa5914b16f908559b0c9dfca8bc9b2579b5a7882b"}, {"path": "README.md", "size": 2272, "hash": "202d8563588ff0f9f7231f6877cd34cfb84d0e9da2c0b71a8e3b8e38079f31e3"}, {"path": "esp_lcd_touch_cst9217.c", "size": 9677, "hash": "cc845328081fc8c501febb4ad86f90745326f315234d83377a1963c76850642b"}, {"path": "idf_component.yml", "size": 492, "hash": "1fc3dd7bc7c2f391b70f58f6cfb226f34a2d5deb9075c70d8465e124a9d4373d"}, {"path": "license.txt", "size": 11358, "hash": "cfc7749b96f63bd31c3c42b5c471bf756814053e847c10f3eb003417bc523d30"}, {"path": "include/esp_lcd_touch_cst9217.h", "size": 1141, "hash": "f4ef7b65b59d935ccc0f33600621d9f39ed4157606409bfdd0c42f3415d8cb44"}]}
|
||||
@@ -0,0 +1 @@
|
||||
idf_component_register(SRCS "esp_lcd_touch_cst9217.c" INCLUDE_DIRS "include" REQUIRES "esp_lcd")
|
||||
@@ -0,0 +1,68 @@
|
||||
# ESP LCD Touch CST9217 Controller
|
||||
|
||||
[](https://components.espressif.com/components/waveshare/esp_lcd_touch_cst9217)
|
||||
|
||||
Implementation of the CST9217 touch controller with esp_lcd_touch component.
|
||||
|
||||
| Touch controller | Communication interface | Component name | Link to datasheet |
|
||||
| :--------------: | :---------------------: | :------------: | :---------------: |
|
||||
| CST9217 | I2C | esp_lcd_touch_cst9217 | [WIKI](https://www.waveshare.com/wiki/7inch-Capacitive-Touch-LCD-C_Datasheets) |
|
||||
|
||||
## Add to project
|
||||
|
||||
Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/).
|
||||
You can add them to your project via `idf.py add-dependancy`, e.g.
|
||||
```
|
||||
idf.py add-dependency esp_lcd_touch_cst9217==0.0.1
|
||||
```
|
||||
|
||||
Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
|
||||
|
||||
## Example use
|
||||
|
||||
Initialization of the touch component.
|
||||
|
||||
```
|
||||
esp_lcd_panel_io_i2c_config_t io_config = ESP_LCD_TOUCH_IO_I2C_CST9217_CONFIG();
|
||||
|
||||
esp_lcd_touch_io_cst9217_config_t tp_cst9217_config = {
|
||||
.dev_addr = io_config.dev_addr,
|
||||
};
|
||||
|
||||
esp_lcd_touch_config_t tp_cfg = {
|
||||
.x_max = CONFIG_LCD_HRES,
|
||||
.y_max = CONFIG_LCD_VRES,
|
||||
.rst_gpio_num = -1,
|
||||
.int_gpio_num = -1,
|
||||
.levels = {
|
||||
.reset = 0,
|
||||
.interrupt = 0,
|
||||
},
|
||||
.flags = {
|
||||
.swap_xy = 0,
|
||||
.mirror_x = 0,
|
||||
.mirror_y = 0,
|
||||
},
|
||||
.driver_data = &tp_cst9217_config,
|
||||
};
|
||||
|
||||
esp_lcd_touch_handle_t tp;
|
||||
esp_lcd_touch_new_i2c_cst9217(io_handle, &tp_cfg, &tp);
|
||||
```
|
||||
|
||||
Read data from the touch controller and store it in RAM memory. It should be called regularly in poll.
|
||||
|
||||
```
|
||||
esp_lcd_touch_read_data(tp);
|
||||
```
|
||||
|
||||
Get one X and Y coordinates with strength of touch.
|
||||
|
||||
```
|
||||
uint16_t touch_x[1];
|
||||
uint16_t touch_y[1];
|
||||
uint16_t touch_strength[1];
|
||||
uint8_t touch_cnt = 0;
|
||||
|
||||
bool touchpad_pressed = esp_lcd_touch_get_coordinates(tp, touch_x, touch_y, touch_strength, &touch_cnt, 1);
|
||||
```
|
||||
@@ -0,0 +1,288 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
|
||||
* SPDX-FileCopyrightText: 2025 Waveshare
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
#include "esp_system.h"
|
||||
#include "esp_err.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_check.h"
|
||||
#include "driver/gpio.h"
|
||||
#include "esp_lcd_panel_io.h"
|
||||
#include "esp_lcd_touch.h"
|
||||
#include "esp_lcd_touch_cst9217.h"
|
||||
|
||||
static const char *TAG = "CST9217";
|
||||
|
||||
/* CST9217 registers */
|
||||
#define ESP_LCD_TOUCH_CST9217_DATA_REG 0xD000
|
||||
#define ESP_LCD_TOUCH_CST9217_PROJECT_ID_REG 0xD204
|
||||
#define ESP_LCD_TOUCH_CST9217_CMD_MODE_REG 0xD101
|
||||
#define ESP_LCD_TOUCH_CST9217_CHECKCODE_REG 0xD1FC
|
||||
#define ESP_LCD_TOUCH_CST9217_RESOLUTION_REG 0xD1F8
|
||||
|
||||
/* CST9217 parameters */
|
||||
#define CST9217_ACK_VALUE 0xAB
|
||||
#define CST9217_MAX_TOUCH_POINTS 1
|
||||
#define CST9217_DATA_LENGTH (CST9217_MAX_TOUCH_POINTS * 5 + 5)
|
||||
|
||||
/*******************************************************************************
|
||||
* Function definitions
|
||||
*******************************************************************************/
|
||||
static esp_err_t esp_lcd_touch_cst9217_read_data(esp_lcd_touch_handle_t tp);
|
||||
static bool esp_lcd_touch_cst9217_get_xy(esp_lcd_touch_handle_t tp, uint16_t *x, uint16_t *y, uint16_t *strength, uint8_t *point_num, uint8_t max_point_num);
|
||||
static esp_err_t esp_lcd_touch_cst9217_del(esp_lcd_touch_handle_t tp);
|
||||
static esp_err_t cst9217_read_reg(esp_lcd_touch_handle_t tp, uint16_t reg, uint8_t *data, size_t len);
|
||||
static esp_err_t cst9217_write_reg(esp_lcd_touch_handle_t tp, uint16_t reg, uint8_t *data, size_t len);
|
||||
static esp_err_t cst9217_reset(esp_lcd_touch_handle_t tp);
|
||||
static esp_err_t cst9217_read_config(esp_lcd_touch_handle_t tp);
|
||||
|
||||
/*******************************************************************************
|
||||
* Public API functions
|
||||
*******************************************************************************/
|
||||
|
||||
esp_err_t esp_lcd_touch_new_i2c_cst9217(const esp_lcd_panel_io_handle_t io, const esp_lcd_touch_config_t *config, esp_lcd_touch_handle_t *out_touch)
|
||||
{
|
||||
esp_err_t ret = ESP_OK;
|
||||
esp_lcd_touch_handle_t cst9217 = NULL;
|
||||
|
||||
ESP_RETURN_ON_FALSE(io && config && out_touch, ESP_ERR_INVALID_ARG, TAG, "Invalid arguments");
|
||||
|
||||
/* Allocate memory for controller */
|
||||
cst9217 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT);
|
||||
ESP_RETURN_ON_FALSE(cst9217, ESP_ERR_NO_MEM, TAG, "No memory for CST9217");
|
||||
|
||||
/* Communication interface */
|
||||
cst9217->io = io;
|
||||
|
||||
/* Set callbacks */
|
||||
cst9217->read_data = esp_lcd_touch_cst9217_read_data;
|
||||
cst9217->get_xy = esp_lcd_touch_cst9217_get_xy;
|
||||
cst9217->del = esp_lcd_touch_cst9217_del;
|
||||
|
||||
/* Mutex init */
|
||||
cst9217->data.lock.owner = portMUX_FREE_VAL;
|
||||
|
||||
/* Save config */
|
||||
memcpy(&cst9217->config, config, sizeof(esp_lcd_touch_config_t));
|
||||
|
||||
/* Initialize reset GPIO */
|
||||
if (cst9217->config.rst_gpio_num != GPIO_NUM_NC)
|
||||
{
|
||||
gpio_config_t rst_gpio_cfg = {
|
||||
.pin_bit_mask = BIT64(cst9217->config.rst_gpio_num),
|
||||
.mode = GPIO_MODE_OUTPUT,
|
||||
};
|
||||
ESP_GOTO_ON_ERROR(gpio_config(&rst_gpio_cfg), err, TAG, "GPIO config failed");
|
||||
}
|
||||
|
||||
/* Hardware reset */
|
||||
ESP_GOTO_ON_ERROR(cst9217_reset(cst9217), err, TAG, "Reset failed");
|
||||
|
||||
/* Read chip configuration */
|
||||
ESP_GOTO_ON_ERROR(cst9217_read_config(cst9217), err, TAG, "Read config failed");
|
||||
|
||||
*out_touch = cst9217;
|
||||
return ESP_OK;
|
||||
|
||||
err:
|
||||
if (cst9217)
|
||||
{
|
||||
esp_lcd_touch_cst9217_del(cst9217);
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Private functions
|
||||
*******************************************************************************/
|
||||
|
||||
static esp_err_t esp_lcd_touch_cst9217_read_data(esp_lcd_touch_handle_t tp)
|
||||
{
|
||||
uint8_t data[CST9217_DATA_LENGTH] = {0};
|
||||
esp_err_t ret = ESP_OK;
|
||||
|
||||
ESP_GOTO_ON_ERROR(
|
||||
cst9217_read_reg(tp, ESP_LCD_TOUCH_CST9217_DATA_REG, data, sizeof(data)),
|
||||
err, TAG, "Read data failed");
|
||||
|
||||
if (data[6] != CST9217_ACK_VALUE) {
|
||||
// ESP_LOGE(TAG, "Invalid ACK: 0x%02X vs 0x%02X", data[6], CST9217_ACK_VALUE);
|
||||
return ESP_ERR_INVALID_RESPONSE;
|
||||
}
|
||||
|
||||
uint8_t points = data[5] & 0x7F;
|
||||
points = (points > CST9217_MAX_TOUCH_POINTS) ? CST9217_MAX_TOUCH_POINTS : points;
|
||||
|
||||
portENTER_CRITICAL(&tp->data.lock);
|
||||
tp->data.points = 0;
|
||||
for (int i = 0; i < points; i++) {
|
||||
uint8_t *p = &data[i * 5 + (i ? 2 : 0)];
|
||||
uint8_t status = p[0] & 0x0F;
|
||||
|
||||
if (status == 0x06) {
|
||||
tp->data.coords[i].x = ((p[1] << 4) | (p[3] >> 4));
|
||||
tp->data.coords[i].y = ((p[2] << 4) | (p[3] & 0x0F));
|
||||
tp->data.points++;
|
||||
|
||||
ESP_LOGV(TAG, "Point %d: X=%d, Y=%d",
|
||||
i, tp->data.coords[i].x, tp->data.coords[i].y);
|
||||
}
|
||||
}
|
||||
portEXIT_CRITICAL(&tp->data.lock);
|
||||
|
||||
return ret;
|
||||
|
||||
err:
|
||||
if (tp->config.rst_gpio_num != GPIO_NUM_NC) {
|
||||
gpio_set_level(tp->config.rst_gpio_num, 0);
|
||||
vTaskDelay(pdMS_TO_TICKS(10));
|
||||
gpio_set_level(tp->config.rst_gpio_num, 1);
|
||||
vTaskDelay(pdMS_TO_TICKS(50));
|
||||
}
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
static bool esp_lcd_touch_cst9217_get_xy(esp_lcd_touch_handle_t tp, uint16_t *x, uint16_t *y, uint16_t *strength, uint8_t *point_num, uint8_t max_point_num)
|
||||
{
|
||||
assert(tp && x && y && point_num);
|
||||
|
||||
portENTER_CRITICAL(&tp->data.lock);
|
||||
*point_num = (tp->data.points > max_point_num) ? max_point_num : tp->data.points;
|
||||
|
||||
for (size_t i = 0; i < *point_num; i++)
|
||||
{
|
||||
x[i] = tp->data.coords[i].x;
|
||||
y[i] = tp->data.coords[i].y;
|
||||
if (strength)
|
||||
strength[i] = 1; /* Strength not supported */
|
||||
}
|
||||
|
||||
portEXIT_CRITICAL(&tp->data.lock);
|
||||
return (*point_num > 0);
|
||||
}
|
||||
|
||||
static esp_err_t esp_lcd_touch_cst9217_del(esp_lcd_touch_handle_t tp)
|
||||
{
|
||||
if (tp->config.rst_gpio_num != GPIO_NUM_NC)
|
||||
{
|
||||
gpio_reset_pin(tp->config.rst_gpio_num);
|
||||
}
|
||||
if (tp->config.int_gpio_num != GPIO_NUM_NC)
|
||||
{
|
||||
gpio_reset_pin(tp->config.int_gpio_num);
|
||||
}
|
||||
free(tp);
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t cst9217_reset(esp_lcd_touch_handle_t tp)
|
||||
{
|
||||
if (tp->config.rst_gpio_num != GPIO_NUM_NC) {
|
||||
ESP_RETURN_ON_ERROR(gpio_set_level(tp->config.rst_gpio_num, 0), TAG, "Reset low failed");
|
||||
vTaskDelay(pdMS_TO_TICKS(10));
|
||||
ESP_RETURN_ON_ERROR(gpio_set_level(tp->config.rst_gpio_num, 1), TAG, "Reset high failed");
|
||||
vTaskDelay(pdMS_TO_TICKS(50));
|
||||
}
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t cst9217_read_config(esp_lcd_touch_handle_t tp)
|
||||
{
|
||||
uint8_t data[4] = {0};
|
||||
esp_err_t ret = ESP_OK;
|
||||
|
||||
uint8_t cmd_mode[2] = {0xD1, 0x01};
|
||||
ESP_RETURN_ON_ERROR(
|
||||
cst9217_write_reg(tp, ESP_LCD_TOUCH_CST9217_CMD_MODE_REG, cmd_mode, sizeof(cmd_mode)),
|
||||
TAG, "Enter command mode failed");
|
||||
vTaskDelay(pdMS_TO_TICKS(10));
|
||||
|
||||
ESP_RETURN_ON_ERROR(
|
||||
cst9217_read_reg(tp, ESP_LCD_TOUCH_CST9217_CHECKCODE_REG, data, 4),
|
||||
TAG, "Read checkcode failed");
|
||||
ESP_LOGI(TAG, "Checkcode: 0x%02X%02X%02X%02X",
|
||||
data[0], data[1], data[2], data[3]);
|
||||
|
||||
ESP_RETURN_ON_ERROR(
|
||||
cst9217_read_reg(tp, ESP_LCD_TOUCH_CST9217_RESOLUTION_REG, data, 4),
|
||||
TAG, "Read resolution failed");
|
||||
uint16_t res_x = (data[1] << 8) | data[0];
|
||||
uint16_t res_y = (data[3] << 8) | data[2];
|
||||
ESP_LOGI(TAG, "Resolution X: %d, Y: %d", res_x, res_y);
|
||||
|
||||
ESP_RETURN_ON_ERROR(
|
||||
cst9217_read_reg(tp, ESP_LCD_TOUCH_CST9217_PROJECT_ID_REG, data, 4),
|
||||
TAG, "Read project ID failed");
|
||||
uint16_t chipType = (data[3] << 8) | data[2];
|
||||
uint32_t projectID = (data[1] << 8) | data[0];
|
||||
ESP_LOGI(TAG, "Chip Type: 0x%04X, ProjectID: 0x%04lX", chipType, projectID);
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
static esp_err_t cst9217_read_reg(esp_lcd_touch_handle_t tp, uint16_t reg, uint8_t *data, size_t len)
|
||||
{
|
||||
uint8_t reg_buf[2] = {reg >> 8, reg & 0xFF};
|
||||
const int max_retries = 5;
|
||||
esp_err_t ret;
|
||||
|
||||
for (int retry = 0; retry < max_retries; retry++) {
|
||||
ret = esp_lcd_panel_io_tx_param(tp->io, reg_buf[0], ®_buf[1], 1);
|
||||
if (ret != ESP_OK) {
|
||||
ESP_LOGD(TAG, "TX failed, retry %d", retry);
|
||||
vTaskDelay(pdMS_TO_TICKS(3));
|
||||
continue;
|
||||
}
|
||||
|
||||
vTaskDelay(pdMS_TO_TICKS(2));
|
||||
|
||||
ret = esp_lcd_panel_io_rx_param(tp->io, -1, data, len);
|
||||
if (ret == ESP_OK) {
|
||||
return ESP_OK;
|
||||
}
|
||||
ESP_LOGD(TAG, "RX failed, retry %d", retry);
|
||||
vTaskDelay(pdMS_TO_TICKS(3));
|
||||
}
|
||||
|
||||
if (tp->config.rst_gpio_num != GPIO_NUM_NC) {
|
||||
ESP_LOGW(TAG, "Trigger hardware reset");
|
||||
gpio_set_level(tp->config.rst_gpio_num, 0);
|
||||
vTaskDelay(pdMS_TO_TICKS(10));
|
||||
gpio_set_level(tp->config.rst_gpio_num, 1);
|
||||
vTaskDelay(pdMS_TO_TICKS(100));
|
||||
}
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
static esp_err_t cst9217_write_reg(esp_lcd_touch_handle_t tp, uint16_t reg, uint8_t *data, size_t len)
|
||||
{
|
||||
uint8_t reg_buf[2] = {reg >> 8, reg & 0xFF};
|
||||
const int max_retries = 5;
|
||||
esp_err_t ret;
|
||||
|
||||
for (int retry = 0; retry < max_retries; retry++) {
|
||||
ret = esp_lcd_panel_io_tx_param(tp->io, reg_buf[0], ®_buf[1], 1);
|
||||
if (ret != ESP_OK) {
|
||||
ESP_LOGD(TAG, "Addr TX failed, retry %d", retry);
|
||||
vTaskDelay(pdMS_TO_TICKS(3));
|
||||
continue;
|
||||
}
|
||||
|
||||
vTaskDelay(pdMS_TO_TICKS(2));
|
||||
|
||||
ret = esp_lcd_panel_io_tx_param(tp->io, data[0], &data[1], len-1);
|
||||
if (ret == ESP_OK) {
|
||||
return ESP_OK;
|
||||
}
|
||||
ESP_LOGD(TAG, "Data TX failed, retry %d", retry);
|
||||
vTaskDelay(pdMS_TO_TICKS(3));
|
||||
}
|
||||
return ESP_FAIL;
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
dependencies:
|
||||
esp_lcd_touch:
|
||||
public: true
|
||||
version: ^1.1.0
|
||||
idf: '>=4.4.2'
|
||||
description: ESP LCD Touch CST9217 -The touch controller CST9217 is adapted by waveshare
|
||||
repository: git://github.com/waveshareteam/Waveshare-ESP32-components.git
|
||||
repository_info:
|
||||
commit_sha: ae555d562a6e8fd7903abdea895da850ad1ec38c
|
||||
path: display/touch/esp_lcd_touch_cst9217
|
||||
url: https://github.com/waveshareteam/Waveshare-ESP32-components/tree/master/display/touch/esp_lcd_touch_cst9217
|
||||
version: 1.0.3
|
||||
@@ -0,0 +1,41 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
|
||||
* SPDX-FileCopyrightText: 2025 Waveshare
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @brief ESP LCD touch: cst9217
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "esp_lcd_touch.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
esp_err_t esp_lcd_touch_new_i2c_cst9217(const esp_lcd_panel_io_handle_t io, const esp_lcd_touch_config_t *config, esp_lcd_touch_handle_t *out_touch);
|
||||
|
||||
#define ESP_LCD_TOUCH_IO_I2C_CST9217_ADDRESS (0x5A)
|
||||
|
||||
#define ESP_LCD_TOUCH_IO_I2C_CST9217_CONFIG() \
|
||||
{ \
|
||||
.dev_addr = ESP_LCD_TOUCH_IO_I2C_CST9217_ADDRESS, \
|
||||
.control_phase_bytes = 1, \
|
||||
.dc_bit_offset = 0, \
|
||||
.lcd_cmd_bits = 8, \
|
||||
.flags = \
|
||||
{ \
|
||||
.disable_control_phase = 1, \
|
||||
}, \
|
||||
}
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
202
managed_components/waveshare__esp_lcd_touch_cst9217/license.txt
Normal file
202
managed_components/waveshare__esp_lcd_touch_cst9217/license.txt
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user