├── .gitignore ├── prj.conf ├── CMakeLists.txt ├── sample.yaml ├── src ├── main.c └── battery │ ├── battery.h │ └── battery.c ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # editors 2 | *.swp 3 | *~ 4 | 5 | # build 6 | /build*/ 7 | -------------------------------------------------------------------------------- /prj.conf: -------------------------------------------------------------------------------- 1 | #Peripherials 2 | CONFIG_GPIO=y 3 | CONFIG_ADC=y 4 | 5 | #USB / Termial 6 | CONFIG_SERIAL=y 7 | CONFIG_LOG=y 8 | 9 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: Apache-2.0 2 | 3 | cmake_minimum_required(VERSION 3.20.0) 4 | find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) 5 | project(peripheral) 6 | 7 | target_sources(app PRIVATE 8 | src/main.c 9 | src/battery/battery.c 10 | ) 11 | -------------------------------------------------------------------------------- /sample.yaml: -------------------------------------------------------------------------------- 1 | sample: 2 | description: Hello World sample, the simplest Zephyr 3 | application 4 | name: hello world 5 | common: 6 | tags: introduction 7 | integration_platforms: 8 | - native_posix 9 | harness: console 10 | harness_config: 11 | type: one_line 12 | regex: 13 | - "Hello World! (.*)" 14 | tests: 15 | sample.basic.helloworld: 16 | tags: introduction 17 | -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2024 Marcus Alexander Tjomsaas 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | #include "battery/battery.h" 18 | 19 | #include 20 | #include 21 | #include 22 | LOG_MODULE_REGISTER(main, LOG_LEVEL_INF); 23 | 24 | struct k_work battery_work; 25 | 26 | void battery_work_handler(struct k_work *work_item) 27 | { 28 | uint16_t battery_millivolt = 0; 29 | uint8_t battery_percentage = 0; 30 | 31 | battery_get_millivolt(&battery_millivolt); 32 | battery_get_percentage(&battery_percentage, battery_millivolt); 33 | 34 | LOG_INF("Battery at %d mV (capacity %d%%)", battery_millivolt, battery_percentage); 35 | } 36 | 37 | int main(void) 38 | { 39 | int ret = 0; 40 | k_msleep(1000); // Gives time for the terminal to connect to catch LOG's 41 | 42 | ret |= battery_init(); 43 | ret |= battery_charge_start(); 44 | 45 | if (ret) 46 | { 47 | LOG_ERR("Failed to initialize"); 48 | } 49 | else 50 | { 51 | LOG_INF("Initialized"); 52 | } 53 | 54 | k_work_init(&battery_work, battery_work_handler); 55 | 56 | while (1) 57 | { 58 | k_msleep(1000); 59 | k_work_submit(&battery_work); 60 | } 61 | 62 | return 0; 63 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # XIAO BLE Sense (nRF52840) Battery Management Library 2 | 3 |

4 |
5 | GitHub Repo stars 6 | Hits 7 |

8 | 9 | ## Overview 10 | This library is designed to manage the battery charging functionality of the XIAO BLE and XIAO BLE Sense board. It supports the following features for a 3.7V LiPo battery: 11 | 12 | - Reading battery voltage. 13 | - Setting charging modes (fast or slow). 14 | - Enabling or disabling charging. 15 | - Calculating battery capacity in percentage. 16 | 17 | The library is built on the Zephyr Real-Time Operating System (RTOS). 18 | For comprehensive details on Zephyr and how to get started, visit the 19 | [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). 20 | 21 | ## Programming and Debugging 22 | ### Adafruit nRF52 Bootloader 23 | The XIAO BLE Sense is equipped with the Adafruit nRF52 Bootloader 5, facilitating the 24 | UF2 flashing process. 25 | 26 | ### UF2 Flashing Process 27 | 28 | 1. **Entering Bootloader Mode**: Connect the XIAO BLE Sense to your computer via USB. 29 | Then, double-tap the reset button located to the left of the USB connector. This 30 | action will enable the bootloader mode, and the device will appear as a mass storage 31 | device named 'XIAO BLE' on your computer. 32 | 33 | 2. **Flashing the Firmware**: 34 | 35 | - Navigate to the '**build/zephyr/**' directory and locate the '**zephyr.uf2**' file. If you can not find the build folder, build or rebuild the zephyr project. 36 | - Copy the **zephyr.uf2** file to the root directory of the XIAO BLE mass storage device using either the command line or your file manager. 37 | 3. **Automatic Reset and Application Launch**: After the UF2 file transfer is complete, 38 | the XIAO BLE Sense will automatically reset and launch the new application. 39 | 40 | For additional information on the flashing process and the XIAO BLE Sense board, refer to 41 | the [Zephyr Board Documentation for XIAO BLE](https://docs.zephyrproject.org/latest/boards/arm/xiao_ble/doc/index.html). 42 | -------------------------------------------------------------------------------- /src/battery/battery.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2024 Marcus Alexander Tjomsaas 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | #include 18 | 19 | #ifndef __BATTERY_H__ 20 | #define __BATTERY_H__ 21 | 22 | /** 23 | * @brief Set battery charging to fast charge (100mA). 24 | * 25 | * @retval 0 if successful. Negative errno number on error. 26 | */ 27 | int battery_set_fast_charge(void); 28 | 29 | /** 30 | * @brief Set battery charging to slow charge (50mA). 31 | * 32 | * @retval 0 if successful. Negative errno number on error. 33 | */ 34 | int battery_set_slow_charge(void); 35 | 36 | /** 37 | * @brief Start battery charging. 38 | * 39 | * @retval 0 if successful. Negative errno number on error. 40 | */ 41 | int battery_charge_start(void); 42 | 43 | /** 44 | * @brief Stop battery charging. 45 | * 46 | * @retval 0 if successful. Negative errno number on error. 47 | * 48 | * @note: want to stop charging to save power during runtime (Disables LED). 49 | */ 50 | int battery_charge_stop(void); 51 | 52 | /** 53 | * @brief Calculates the battery voltage using the ADC. 54 | * 55 | * @param[in] battery_millivolt Pointer to where battery voltage is stored. 56 | * 57 | * @retval 0 if successful. Negative errno number on error. 58 | */ 59 | int battery_get_millivolt(uint16_t *battery_millivolt); 60 | 61 | /** 62 | * @brief Calculates the battery percentage using the battery voltage. 63 | * 64 | * @param[in] battery_percentage Pointer to where battery percentage is stored. 65 | * 66 | * @param[in] battery_millivolt Voltage used to calculate the percentage of how much energy is left in a 3.7V LiPo battery. 67 | * 68 | * @retval 0 if successful. Negative errno number on error. 69 | */ 70 | int battery_get_percentage(uint8_t *battery_percentage, uint16_t battery_millivolt); 71 | 72 | /** 73 | * @brief Initialize the battery charging circuit. 74 | * 75 | * @retval 0 if successful. Negative errno number on error. 76 | */ 77 | int battery_init(void); 78 | 79 | #endif -------------------------------------------------------------------------------- /src/battery/battery.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2024 Marcus Alexander Tjomsaas 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | #include "battery.h" 18 | 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | LOG_MODULE_REGISTER(battery, LOG_LEVEL_INF); 26 | 27 | static const struct device *gpio_battery_dev = DEVICE_DT_GET(DT_NODELABEL(gpio0)); 28 | static const struct device *adc_battery_dev = DEVICE_DT_GET(DT_NODELABEL(adc)); 29 | 30 | static K_MUTEX_DEFINE(battery_mut); 31 | 32 | #define GPIO_BATTERY_CHARGE_SPEED 13 33 | #define GPIO_BATTERY_CHARGING_ENABLE 17 34 | #define GPIO_BATTERY_READ_ENABLE 14 35 | 36 | // Change this to a higher number for better averages 37 | // Note that increasing this holds up the thread / ADC for longer. 38 | #define ADC_TOTAL_SAMPLES 10 39 | int16_t sample_buffer[ADC_TOTAL_SAMPLES]; 40 | 41 | #define ADC_RESOLUTION 12 42 | #define ADC_CHANNEL 7 43 | #define ADC_PORT SAADC_CH_PSELP_PSELP_AnalogInput7 // AIN7 44 | #define ADC_REFERENCE ADC_REF_INTERNAL // 0.6V 45 | #define ADC_GAIN ADC_GAIN_1_6 // ADC REFERENCE * 6 = 3.6V 46 | 47 | struct adc_channel_cfg channel_7_cfg = { 48 | .gain = ADC_GAIN, 49 | .reference = ADC_REFERENCE, 50 | .acquisition_time = ADC_ACQ_TIME_DEFAULT, 51 | .channel_id = ADC_CHANNEL, 52 | #ifdef CONFIG_ADC_NRFX_SAADC 53 | .input_positive = ADC_PORT 54 | #endif 55 | }; 56 | 57 | static struct adc_sequence_options options = { 58 | .extra_samplings = ADC_TOTAL_SAMPLES - 1, 59 | .interval_us = 500, // Interval between each sample 60 | }; 61 | 62 | struct adc_sequence sequence = { 63 | .options = &options, 64 | .channels = BIT(ADC_CHANNEL), 65 | .buffer = sample_buffer, 66 | .buffer_size = sizeof(sample_buffer), 67 | .resolution = ADC_RESOLUTION, 68 | }; 69 | 70 | typedef struct 71 | { 72 | uint16_t voltage; 73 | uint8_t percentage; 74 | } BatteryState; 75 | 76 | #define BATTERY_STATES_COUNT 12 77 | // Assuming LiPo battery. 78 | // Source: https://forum.evolvapor.com/topic/65565-discharge-profiles-csv-for-2-3-18650-batteries-sony-vtc6-sammy-30q/ 79 | // SHOULD USE YOUR BATTERY'S DATASHEET 80 | BatteryState battery_states[BATTERY_STATES_COUNT] = { 81 | {4200, 100}, 82 | {4160, 99}, 83 | {4090, 91}, 84 | {4030, 78}, 85 | {3890, 63}, 86 | {3830, 53}, 87 | {3680, 36}, 88 | {3660, 35}, 89 | {3480, 14}, 90 | {3420, 11}, 91 | {3150, 1}, // 3240 92 | {0000, 0} // Below safe level 93 | }; 94 | 95 | static uint8_t is_initialized = false; 96 | 97 | static int battery_enable_read() 98 | { 99 | return gpio_pin_set(gpio_battery_dev, GPIO_BATTERY_READ_ENABLE, 1); 100 | } 101 | 102 | int battery_set_fast_charge() 103 | { 104 | if (!is_initialized) 105 | { 106 | return -ECANCELED; 107 | } 108 | 109 | return gpio_pin_set(gpio_battery_dev, GPIO_BATTERY_CHARGE_SPEED, 1); // FAST charge 100mA 110 | } 111 | 112 | int battery_set_slow_charge() 113 | { 114 | if (!is_initialized) 115 | { 116 | return -ECANCELED; 117 | } 118 | 119 | return gpio_pin_set(gpio_battery_dev, GPIO_BATTERY_CHARGE_SPEED, 0); // SLOW charge 50mA 120 | } 121 | 122 | int battery_charge_start() 123 | { 124 | int ret = 0; 125 | 126 | if (!is_initialized) 127 | { 128 | return -ECANCELED; 129 | } 130 | ret |= battery_enable_read(); 131 | ret |= gpio_pin_set(gpio_battery_dev, GPIO_BATTERY_CHARGING_ENABLE, 1); 132 | return ret; 133 | } 134 | 135 | int battery_charge_stop() 136 | { 137 | if (!is_initialized) 138 | { 139 | return -ECANCELED; 140 | } 141 | 142 | return gpio_pin_set(gpio_battery_dev, GPIO_BATTERY_CHARGING_ENABLE, 0); 143 | } 144 | 145 | int battery_get_millivolt(uint16_t *battery_millivolt) 146 | { 147 | 148 | int ret = 0; 149 | 150 | // Voltage divider circuit (Should tune R1 in software if possible) 151 | const uint16_t R1 = 1037; // Originally 1M ohm, calibrated after measuring actual voltage values. Can happen due to resistor tolerances, temperature ect.. 152 | const uint16_t R2 = 510; // 510K ohm 153 | 154 | // ADC measure 155 | uint16_t adc_vref = adc_ref_internal(adc_battery_dev); 156 | int adc_mv = 0; 157 | 158 | k_mutex_lock(&battery_mut, K_FOREVER); 159 | ret |= adc_read(adc_battery_dev, &sequence); 160 | 161 | if (ret) 162 | { 163 | LOG_WRN("ADC read failed (error %d)", ret); 164 | } 165 | 166 | // Get average sample value. 167 | for (uint8_t sample = 0; sample < ADC_TOTAL_SAMPLES; sample++) 168 | { 169 | adc_mv += sample_buffer[sample]; // ADC value, not millivolt yet. 170 | } 171 | adc_mv /= ADC_TOTAL_SAMPLES; 172 | 173 | // Convert ADC value to millivolts 174 | ret |= adc_raw_to_millivolts(adc_vref, ADC_GAIN, ADC_RESOLUTION, &adc_mv); 175 | 176 | // Calculate battery voltage. 177 | *battery_millivolt = adc_mv * ((R1 + R2) / R2); 178 | k_mutex_unlock(&battery_mut); 179 | 180 | LOG_DBG("%d mV", *battery_millivolt); 181 | return ret; 182 | } 183 | 184 | int battery_get_percentage(uint8_t *battery_percentage, uint16_t battery_millivolt) 185 | { 186 | 187 | // Ensure voltage is within bounds 188 | if (battery_millivolt > battery_states[0].voltage) 189 | *battery_percentage = 100; 190 | if (battery_millivolt < battery_states[BATTERY_STATES_COUNT - 1].voltage) 191 | *battery_percentage = 0; 192 | 193 | for (uint16_t i = 0; i < BATTERY_STATES_COUNT - 1; i++) 194 | { 195 | // Find the two points battery_millivolt is between 196 | if (battery_states[i].voltage >= battery_millivolt && battery_millivolt >= battery_states[i + 1].voltage) 197 | { 198 | // Linear interpolation 199 | *battery_percentage = battery_states[i].percentage + 200 | ((float)(battery_millivolt - battery_states[i].voltage) * 201 | ((float)(battery_states[i + 1].percentage - battery_states[i].percentage) / 202 | (float)(battery_states[i + 1].voltage - battery_states[i].voltage))); 203 | 204 | LOG_DBG("%d %%", *battery_percentage); 205 | return 0; 206 | } 207 | } 208 | return -ESPIPE; 209 | } 210 | 211 | int battery_init() 212 | { 213 | int ret = 0; 214 | 215 | // ADC 216 | if (!device_is_ready(adc_battery_dev)) 217 | { 218 | LOG_ERR("ADC device not found!"); 219 | return -EIO; 220 | } 221 | 222 | ret |= adc_channel_setup(adc_battery_dev, &channel_7_cfg); 223 | 224 | if (ret) 225 | { 226 | LOG_ERR("ADC setup failed (error %d)", ret); 227 | } 228 | 229 | // GPIO 230 | if (!device_is_ready(gpio_battery_dev)) 231 | { 232 | LOG_ERR("GPIO device not found!"); 233 | return -EIO; 234 | } 235 | 236 | ret |= gpio_pin_configure(gpio_battery_dev, GPIO_BATTERY_CHARGING_ENABLE, GPIO_OUTPUT | GPIO_ACTIVE_LOW); 237 | ret |= gpio_pin_configure(gpio_battery_dev, GPIO_BATTERY_READ_ENABLE, GPIO_OUTPUT | GPIO_ACTIVE_LOW); 238 | ret |= gpio_pin_configure(gpio_battery_dev, GPIO_BATTERY_CHARGE_SPEED, GPIO_OUTPUT | GPIO_ACTIVE_LOW); 239 | 240 | if (ret) 241 | { 242 | LOG_ERR("GPIO configure failed!"); 243 | return ret; 244 | } 245 | 246 | if (ret) 247 | { 248 | LOG_ERR("Initialization failed (error %d)", ret); 249 | return ret; 250 | } 251 | 252 | is_initialized = true; 253 | LOG_INF("Initialized"); 254 | 255 | ret |= battery_enable_read(); 256 | ret |= battery_set_fast_charge(); 257 | 258 | return ret; 259 | } 260 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2024 Marcus Alexander Tjomsaas 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------