├── Arduino Code - With Step-Dir Listener for Klipper ├── README.md └── LICENSE /Arduino Code - With Step-Dir Listener for Klipper: -------------------------------------------------------------------------------- 1 | #include 2 | BLDCMotor motor = BLDCMotor(2); //Probably leave as 2 for every linear motor combo 3 | BLDCDriver3PWM driver = BLDCDriver3PWM(PB6, PB4, PB10, PA9); 4 | Encoder encoder = Encoder(PC8, PC6, 1120); //1120 was found via trial and error. 5 | void doA(){encoder.handleA();} 6 | void doB(){encoder.handleB();} 7 | // angle set point variable 8 | float received_angle = 0; 9 | // instantiate the commander 10 | Commander command = Commander(Serial); 11 | void onMotor(char* cmd){ command.motor(&motor,cmd); } 12 | InlineCurrentSense current_sense = InlineCurrentSense(0.01, 50, A0, A2, _NC); 13 | StepDirListener step_dir = StepDirListener(PA15, PC12, 0.0014); // Comment out if want to use commander 14 | void onStep() { step_dir.handle(); } // Comment out if want to use commander 15 | 16 | void setup() { 17 | command.add('M',onMotor,"LinMot"); 18 | 19 | // setting the limits 20 | motor.velocity_limit = 99999; 21 | motor.voltage_limit = 24; 22 | motor.current_limit = 9999999; 23 | 24 | encoder.quadrature = Quadrature::ON; 25 | encoder.init(); 26 | encoder.enableInterrupts(doA, doB); 27 | motor.linkSensor(&encoder); 28 | 29 | // driver config 30 | driver.pwm_frequency = 25000; 31 | driver.voltage_power_supply = 24; 32 | 33 | driver.init(); 34 | current_sense.linkDriver(&driver); 35 | motor.linkDriver(&driver); 36 | // initialize motor 37 | motor.init(); 38 | // init current sense 39 | current_sense.init(); 40 | motor.linkCurrentSense(¤t_sense); 41 | 42 | motor.voltage_sensor_align = 3; 43 | motor.velocity_index_search = 3; 44 | motor.foc_modulation = FOCModulationType::SpaceVectorPWM; 45 | motor.controller = MotionControlType::angle; 46 | motor.torque_controller = TorqueControlType::foc_current; 47 | 48 | // velocity PID controller parameters 49 | motor.PID_velocity.P = 0.6; 50 | motor.PID_velocity.I = 0; 51 | motor.PID_velocity.D = 0; 52 | motor.PID_velocity.output_ramp = 0; 53 | motor.LPF_velocity.Tf = 0.001; 54 | 55 | // angle PID controller 56 | motor.P_angle.P = 100; //200 57 | motor.P_angle.I = 0; //0.4 58 | motor.P_angle.D = 0; //2.0 59 | motor.P_angle.output_ramp = 0; 60 | motor.LPF_angle.Tf = 0; 61 | 62 | // foc current control parameters 63 | motor.PID_current_q.P = 1; 64 | motor.PID_current_q.I= 0.1; 65 | motor.PID_current_d.P= 1; 66 | motor.PID_current_d.I = 0.1; 67 | motor.LPF_current_q.Tf = 0.01; 68 | motor.LPF_current_d.Tf = 0.01; 69 | 70 | motor.motion_downsample = 0; 71 | motor.useMonitoring(Serial); 72 | Serial.begin(115200); 73 | 74 | motor.initFOC(); 75 | step_dir.init();// Comment out if want to use commander 76 | step_dir.enableInterrupt(onStep);// Comment out if want to use commander 77 | step_dir.attach(&received_angle);// Comment out if want to use commander 78 | //delay(10000); 79 | } 80 | 81 | void loop() { 82 | motor.loopFOC(); 83 | motor.move(received_angle); 84 | motor.monitor(); 85 | command.run(); 86 | } 87 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DIY-Linear-Motor 2 | Official Discord (https://discord.com/invite/5FmVrjaZHb) 3 | 4 | https://www.youtube.com/watch?v=wEBWoIjgftI 5 | 6 | This is an attempt to make a high performance and low cost linear motor for the diy hobby user. This can be adapted to any use case as needed, 3D printer, pick and place etc. See here for background on operating principle. 7 | 8 | Performance: A 6 coil forcer was able generate peak of 16N of force. This can't be sustained for long as the coils would eventually melt. 9 | 10 | https://en.wikipedia.org/wiki/Linear_motor 11 | 12 | ## Research and Sim (coil and magnet) + Market Options 13 | 14 | First steps was research exisiting designs and perform simulations where possible. 15 | 16 | The following two projects were very helpful in the early stages: 17 | - https://www.instructables.com/DIY-IRONLESS-LINEAR-SERVO-MOTOR/ 18 | - https://github.com/TkkrLab/LinearMotor 19 | 20 | Summary of coil and magnet pitch is also as follows. 21 | Since there is conflicting arrangements of coil and magnet pitches based on the information available some simulation was required. Using Ansys electrical some key parameters were discovered, both flat and round motor designs were tested but only the round was pursued further due to the easier construction techniques. Starting with permanent magnets and the magnet tube, there is commercially available 13mm OD - 12.1mm ID aluminium tube https://tinyurl.com/5435frky that is available for hobby plane builds, this can be purchased locally in 1m lengths and bears the label KS Precision Metals from USA. Therefore 12mm OD permanent magnets fit snugly inside with little wasted space. The available lengths of 12mm permanent magnets vary from 15-30mm, this sets the both the magnet pitch and the coil pitch which affects the overall length of the forcer and available stroke. I decided to go with 20mm long magnets, which makes the N-N magnet pitch at 40mm. Inputing this into the simulation, the coil design was refined until a clean three phase back EMF was obtained, this was an iterative process that ended up with a coil spacing of 6.8mm. Once the spacing of the coils and magnets were fixed, optimisation of the number of turns and wire gauge was next. A target for maximum force to amperage ratio was slightly preferred over force to weight ratio. Using some initial parameters set by the motor driver (more details below), the phase to phase resistance should be greater than 10 ohms, with a design voltage of 35V means peak current would be approximately 3.5 amps, with the motor driver capable of 5 amp peak. Starting off with one set of three coils, each coil should provide 5 ohms of resistance, using the website (coil24) ID is fixed at 14mm to allow for clearance to the 13mm magnet tube, coil width is set to 6.35mm so wiring and the 6.8mm spacing can be honoured (more details later). Different wire gauges were tested keeping the above parameters the same and changing the number of turns to suit. This was repeated for dual and triple coils in series but with invertred winding direction. The summary of the findings are below. 22 | ![image](https://github.com/cmore839/DIY-Linear-Motor/assets/85714349/eebe09a1-eace-40f4-a375-98fe96b4f446) 23 | 24 | The dual coil set was picked since the efficiency of force/amperage was quite high without going to the extra effort of make 9 coils for a triple set. 25 | 26 | ## Electronics Market 27 | 28 | Alot of this project was enabled by the keen interest in the Arduino-FOC project being run over at https://docs.simplefoc.com/. There is a huge amount of information and support to get normal motors running in closed loop with great performance. I was keen to try and get a linear motor running using the same platform. 29 | 30 | After some learnings and process of elimination the best combination of electronics was followings 31 | - Ardunio brain: STM32 NUCLEO-G474RE 32 | - Motor Driver SimpleFOCShield v2.0.4 (Aliexpress): https://docs.simplefoc.com/arduino_simplefoc_shield_showcase 33 | - Encoder (Aliexpress): HEDS9740 360LPI 34 | 35 | The NUCLEO-G474RE is the workhorse of the STM32 family with the highest clock speed and has been fully backwards compatible with SFOC library up to date. 36 | 37 | Motor driver is based on the L6234 from ST, this is a well known chip which has a really nice implementation on the SFOC Shield with built in current sensing. In addition it has voltage regulator and an optimised layout which made me not reinvent the wheel on this aspect. 38 | 39 | In order for closed loop control to be sucessful a linear encoder is needed the HEDS9740 360LPI was chosen due to the cost and performance ratio. In quadrature mode, a single step should be 17 micrometers, for bigger budget projects the RLS magnet strip and board level incremental encoder would be great, this could give 5 micron step size. 40 | 41 | ## Mechanical build (electronics below) 42 | 43 | Magent tube - this was relatively straightforward, I decided to super glue two individual magents together to reduce the overall length that needed to be compressed, this was a small jig in a vice made out of PE so the glue wouldn't stick, it was debatable if this was worth it. Next was to insert all of the magnets into the aluminium tube with one end capped with tape and a wooden dowel inserted first to move the first magnet away from the end of the tube. With a liberal amount of 2 part epoxy placed in the tube and on each magnet, the magnets are all placed in the same pole facing one another, this means a clamping force is required overnight while the glue sets, a simple woodworking clamp did the trick. 44 | 45 | ### Coils - Mechanical 46 | 47 | Since this is a round linear motor, the winding process was slightly easier than a rectangular flat coil for a u-shaped linear motor. It took quite a lot of trial and error even to get a average looking coil, this all required testing different glues and jigs. I ended up using my 3 axis CNC router with a servo as a spindle, this essentially gave me a very large coil winding machine. The coil arbors we're made out of HDPE with a shoulder screw being the central core giving strength and straightness. The wire needs a guide close to the arbor as well as a way of adding tension to the system. In the end I used an old inflatable ball needle for the wire guide and a cloth in a vice provided the winding tension. https://youtu.be/FTWShWmTZQY The coil I ended up making was the following: 48 | 49 | ![Coil](https://github.com/cmore839/DIY-Linear-Motor/assets/85714349/5ed4f1ec-23f9-4d8c-a79b-02f437204583) 50 | 51 | As I was using the CNC router I just wrote a gcode to do the coil winding number of turns while moving a single axis along the pitch of the coils and tweaked it from there if the coil jumped or didn't fill properly. This turned out to be very difficult, especially since it has 16 layers and 249 turns, getting everything sitting perfectly was fairly unachievable. I eventually got a code that worked okay as well as working on the basics need for the arbor design and the glue needed, since the coil needs constant tension or else it will unwind, I ended up using a two part epoxy that was applied between every layer while winding this had to sit overnight, and once set, placing the arbor in the freezer for 5 mins freed the copper coil easily. Other glues that I tried and failed were superglue, nail varnish and timber varnish. Once you have your six coils done with about 10 cm of flying lead on each end I assembled them together and then wired up in sequence. See schematic below for an overview of mechanical layout and electrical wiring. 52 | 53 | ![image](https://github.com/cmore839/DIY-Linear-Motor/assets/85714349/5741d79e-42e8-4a73-bbd6-5ad66c6dc14c) 54 | 55 | 56 | In order to get the coils spaced to the simulation value, I used small hole punch circles of plastic to sit between each layer, these were superglued in place as a temporary holder to achieve the 6.8mm coil pitch, this needs to be done for each coil and then placed in the correct configuration (see layout drawing of coil polarity). Note: A stack of three coils is 20mm even though the pitch above is 6.8mm. So overall your 6 coils will be a nice 40mm long. For my prototype I aligned the six coils of the internal diameters with another HDPE Arbor, this ensured the clearance around the magnet tube is kept even without scratching. I used some more two part epoxy to set this all in place. Soldering the ends of each coil in series and delta Y configuration is again as per the coil layout drawing, leaving just the three phases A,B,C for connection to the motor driver. 57 | 58 | ## Assembly 59 | 60 | The coil set sits on a small mgn9 linear bearing carriage and rail, I machined some small brackets from acrylic sheet, this held the magnet tube in place and secured the coils over the whole length of travel. There is plenty of room for improvement in the brackets, but for a prototype this wasn't the priority. The linear encoder head was attached to the moving carriage and the encoder strip was attached to the magnet tube end brackets, one end was a M3 countersunk screw and the other end was a wire flexure that kept the strip tight. Cable strain relief was a problem which needed to be paid attention to, mostly due to the sensitive pin terminations on the encoder; this was fixed later with an encoder breakout board (see picture). 61 | 62 | NOTE: I found out the hard way that even stainless steel bolts are affected by the permanent magnets too strongly and cause issues. Where possible any screws that are on the moving carriage need to be either plastic or aluminium screws. 63 | 64 | # Motor driver - Setup and First Run (SimpleFOC) 65 | 66 | A Lot of this project was centered around the possibility of getting the SimpleFOC Arduino library working with a linear motor, given the limited information this was tricky to navigate initially. Hopefully this helps with other people trying to get up and running. (There is some assumed knowledge that I won't touch on, with the SFOC website and forums being very helpful). 67 | 68 | Once you've got the SFOC library installed as well as the STM32 offical library from STMicro (very important), you are ready to do some pre-checks and calibration. 69 | ### Encoder Check (Don't SKIP) 70 | Under the SFOC example list, utilities, sensor test, and select your appropiate encoder, in this case just standed AB encoder. This checks the pinout for your encoder (and you can ignore the CPR number for now, just leave as default). Once you get a decent position and velocity curve like demonstrated here moving by hand (https://youtu.be/7zi0S_LTSNg) you can continue to pole pair. 71 | ### Pole Pair Calibration 72 | Under the SFOC example list, utilities, calibratrion, find pole pairs, encoder, launch the find pole pairs number test code (FPPN). Here we're trying to find a specific number for the encoder CPR that gives us a round number when running the FPPN code. Starting with (1) in the BLDCMotor line, add in your 3PWM driver phase and enable pinouts, as well as your encoder pinouts your verified above. With a best guess CPR number put into last variable of the encoder settings. Run this code and wait for it to complete. What the script is doing is checking running the coils in open loop angle mode and counting the number of encoder pulses (encoder angle), what we want is for the numbers calculated to be a nice round number! 73 | 74 | For example (using a reduced pp_search_angle = 3*PI as my motor is too short) 75 | 76 | PP = Electrical angle / Encoder angle 77 | 78 | Encoder CPR = 1110, PP = 540.00/-272.27=-1.98, Close but the encoder angle isn't a round number. 79 | 80 | Encoder CPR = 1130, PP = 540.00/-267.53=-2.02, Close but the encoder angle still isn't a round number. 81 | 82 | Encoder CPR = 1120, PP = 540.00/-270.00=-2.00, Perfect encoder angle. 83 | 84 | So for the final code, the BLDCMotor and encoder line will look like this: 85 | 86 | BLDCMotor motor = BLDCMotor(2); 87 | 88 | Encoder encoder = Encoder(PC8, PC6, 1120); //Pinout may vary. 89 | 90 | ### Adding the rest 91 | After that is complete the rest is plug and play with standard SFOC library. Start out with voltage based, torque closed loop, ideally using commander and SFOC Studio to monitor and tune the motor. Then move to voltage base angle control. Then lastly FOC_Current angle control, there was a trick with the inline current sense that I found which required the third term to need the _NC, rather than just leaving it default. 92 | 93 | ### Klipper Interface 94 | In order to use this motor driver with an exteral controller I'm using the step/dir listener provided by the SFOC community, this works great as long as you can keep the electrical noise low and speeds at a reasonable limit (more testing needed!). https://youtu.be/fjbZ5hjDKrU 95 | 96 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This work is licensed under Attribution-NonCommercial 4.0 International 2 | 3 | Attribution-NonCommercial 4.0 International 4 | 5 | ======================================================================= 6 | 7 | Creative Commons Corporation ("Creative Commons") is not a law firm and 8 | does not provide legal services or legal advice. Distribution of 9 | Creative Commons public licenses does not create a lawyer-client or 10 | other relationship. Creative Commons makes its licenses and related 11 | information available on an "as-is" basis. Creative Commons gives no 12 | warranties regarding its licenses, any material licensed under their 13 | terms and conditions, or any related information. Creative Commons 14 | disclaims all liability for damages resulting from their use to the 15 | fullest extent possible. 16 | 17 | Using Creative Commons Public Licenses 18 | 19 | Creative Commons public licenses provide a standard set of terms and 20 | conditions that creators and other rights holders may use to share 21 | original works of authorship and other material subject to copyright 22 | and certain other rights specified in the public license below. The 23 | following considerations are for informational purposes only, are not 24 | exhaustive, and do not form part of our licenses. 25 | 26 | Considerations for licensors: Our public licenses are 27 | intended for use by those authorized to give the public 28 | permission to use material in ways otherwise restricted by 29 | copyright and certain other rights. Our licenses are 30 | irrevocable. Licensors should read and understand the terms 31 | and conditions of the license they choose before applying it. 32 | Licensors should also secure all rights necessary before 33 | applying our licenses so that the public can reuse the 34 | material as expected. Licensors should clearly mark any 35 | material not subject to the license. This includes other CC- 36 | licensed material, or material used under an exception or 37 | limitation to copyright. More considerations for licensors: 38 | wiki.creativecommons.org/Considerations_for_licensors 39 | 40 | Considerations for the public: By using one of our public 41 | licenses, a licensor grants the public permission to use the 42 | licensed material under specified terms and conditions. If 43 | the licensor's permission is not necessary for any reason--for 44 | example, because of any applicable exception or limitation to 45 | copyright--then that use is not regulated by the license. Our 46 | licenses grant only permissions under copyright and certain 47 | other rights that a licensor has authority to grant. Use of 48 | the licensed material may still be restricted for other 49 | reasons, including because others have copyright or other 50 | rights in the material. A licensor may make special requests, 51 | such as asking that all changes be marked or described. 52 | Although not required by our licenses, you are encouraged to 53 | respect those requests where reasonable. More considerations 54 | for the public: 55 | wiki.creativecommons.org/Considerations_for_licensees 56 | 57 | ======================================================================= 58 | 59 | Creative Commons Attribution-NonCommercial 4.0 International Public 60 | License 61 | 62 | By exercising the Licensed Rights (defined below), You accept and agree 63 | to be bound by the terms and conditions of this Creative Commons 64 | Attribution-NonCommercial 4.0 International Public License ("Public 65 | License"). To the extent this Public License may be interpreted as a 66 | contract, You are granted the Licensed Rights in consideration of Your 67 | acceptance of these terms and conditions, and the Licensor grants You 68 | such rights in consideration of benefits the Licensor receives from 69 | making the Licensed Material available under these terms and 70 | conditions. 71 | 72 | 73 | Section 1 -- Definitions. 74 | 75 | a. Adapted Material means material subject to Copyright and Similar 76 | Rights that is derived from or based upon the Licensed Material 77 | and in which the Licensed Material is translated, altered, 78 | arranged, transformed, or otherwise modified in a manner requiring 79 | permission under the Copyright and Similar Rights held by the 80 | Licensor. For purposes of this Public License, where the Licensed 81 | Material is a musical work, performance, or sound recording, 82 | Adapted Material is always produced where the Licensed Material is 83 | synched in timed relation with a moving image. 84 | 85 | b. Adapter's License means the license You apply to Your Copyright 86 | and Similar Rights in Your contributions to Adapted Material in 87 | accordance with the terms and conditions of this Public License. 88 | 89 | c. Copyright and Similar Rights means copyright and/or similar rights 90 | closely related to copyright including, without limitation, 91 | performance, broadcast, sound recording, and Sui Generis Database 92 | Rights, without regard to how the rights are labeled or 93 | categorized. For purposes of this Public License, the rights 94 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 95 | Rights. 96 | d. Effective Technological Measures means those measures that, in the 97 | absence of proper authority, may not be circumvented under laws 98 | fulfilling obligations under Article 11 of the WIPO Copyright 99 | Treaty adopted on December 20, 1996, and/or similar international 100 | agreements. 101 | 102 | e. Exceptions and Limitations means fair use, fair dealing, and/or 103 | any other exception or limitation to Copyright and Similar Rights 104 | that applies to Your use of the Licensed Material. 105 | 106 | f. Licensed Material means the artistic or literary work, database, 107 | or other material to which the Licensor applied this Public 108 | License. 109 | 110 | g. Licensed Rights means the rights granted to You subject to the 111 | terms and conditions of this Public License, which are limited to 112 | all Copyright and Similar Rights that apply to Your use of the 113 | Licensed Material and that the Licensor has authority to license. 114 | 115 | h. Licensor means the individual(s) or entity(ies) granting rights 116 | under this Public License. 117 | 118 | i. NonCommercial means not primarily intended for or directed towards 119 | commercial advantage or monetary compensation. For purposes of 120 | this Public License, the exchange of the Licensed Material for 121 | other material subject to Copyright and Similar Rights by digital 122 | file-sharing or similar means is NonCommercial provided there is 123 | no payment of monetary compensation in connection with the 124 | exchange. 125 | 126 | j. Share means to provide material to the public by any means or 127 | process that requires permission under the Licensed Rights, such 128 | as reproduction, public display, public performance, distribution, 129 | dissemination, communication, or importation, and to make material 130 | available to the public including in ways that members of the 131 | public may access the material from a place and at a time 132 | individually chosen by them. 133 | 134 | k. Sui Generis Database Rights means rights other than copyright 135 | resulting from Directive 96/9/EC of the European Parliament and of 136 | the Council of 11 March 1996 on the legal protection of databases, 137 | as amended and/or succeeded, as well as other essentially 138 | equivalent rights anywhere in the world. 139 | 140 | l. You means the individual or entity exercising the Licensed Rights 141 | under this Public License. Your has a corresponding meaning. 142 | 143 | 144 | Section 2 -- Scope. 145 | 146 | a. License grant. 147 | 148 | 1. Subject to the terms and conditions of this Public License, 149 | the Licensor hereby grants You a worldwide, royalty-free, 150 | non-sublicensable, non-exclusive, irrevocable license to 151 | exercise the Licensed Rights in the Licensed Material to: 152 | 153 | a. reproduce and Share the Licensed Material, in whole or 154 | in part, for NonCommercial purposes only; and 155 | 156 | b. produce, reproduce, and Share Adapted Material for 157 | NonCommercial purposes only. 158 | 159 | 2. Exceptions and Limitations. For the avoidance of doubt, where 160 | Exceptions and Limitations apply to Your use, this Public 161 | License does not apply, and You do not need to comply with 162 | its terms and conditions. 163 | 164 | 3. Term. The term of this Public License is specified in Section 165 | 6(a). 166 | 167 | 4. Media and formats; technical modifications allowed. The 168 | Licensor authorizes You to exercise the Licensed Rights in 169 | all media and formats whether now known or hereafter created, 170 | and to make technical modifications necessary to do so. The 171 | Licensor waives and/or agrees not to assert any right or 172 | authority to forbid You from making technical modifications 173 | necessary to exercise the Licensed Rights, including 174 | technical modifications necessary to circumvent Effective 175 | Technological Measures. For purposes of this Public License, 176 | simply making modifications authorized by this Section 2(a) 177 | (4) never produces Adapted Material. 178 | 179 | 5. Downstream recipients. 180 | 181 | a. Offer from the Licensor -- Licensed Material. Every 182 | recipient of the Licensed Material automatically 183 | receives an offer from the Licensor to exercise the 184 | Licensed Rights under the terms and conditions of this 185 | Public License. 186 | 187 | b. No downstream restrictions. You may not offer or impose 188 | any additional or different terms or conditions on, or 189 | apply any Effective Technological Measures to, the 190 | Licensed Material if doing so restricts exercise of the 191 | Licensed Rights by any recipient of the Licensed 192 | Material. 193 | 194 | 6. No endorsement. Nothing in this Public License constitutes or 195 | may be construed as permission to assert or imply that You 196 | are, or that Your use of the Licensed Material is, connected 197 | with, or sponsored, endorsed, or granted official status by, 198 | the Licensor or others designated to receive attribution as 199 | provided in Section 3(a)(1)(A)(i). 200 | 201 | b. Other rights. 202 | 203 | 1. Moral rights, such as the right of integrity, are not 204 | licensed under this Public License, nor are publicity, 205 | privacy, and/or other similar personality rights; however, to 206 | the extent possible, the Licensor waives and/or agrees not to 207 | assert any such rights held by the Licensor to the limited 208 | extent necessary to allow You to exercise the Licensed 209 | Rights, but not otherwise. 210 | 211 | 2. Patent and trademark rights are not licensed under this 212 | Public License. 213 | 214 | 3. To the extent possible, the Licensor waives any right to 215 | collect royalties from You for the exercise of the Licensed 216 | Rights, whether directly or through a collecting society 217 | under any voluntary or waivable statutory or compulsory 218 | licensing scheme. In all other cases the Licensor expressly 219 | reserves any right to collect such royalties, including when 220 | the Licensed Material is used other than for NonCommercial 221 | purposes. 222 | 223 | 224 | Section 3 -- License Conditions. 225 | 226 | Your exercise of the Licensed Rights is expressly made subject to the 227 | following conditions. 228 | 229 | a. Attribution. 230 | 231 | 1. If You Share the Licensed Material (including in modified 232 | form), You must: 233 | 234 | a. retain the following if it is supplied by the Licensor 235 | with the Licensed Material: 236 | 237 | i. identification of the creator(s) of the Licensed 238 | Material and any others designated to receive 239 | attribution, in any reasonable manner requested by 240 | the Licensor (including by pseudonym if 241 | designated); 242 | 243 | ii. a copyright notice; 244 | 245 | iii. a notice that refers to this Public License; 246 | 247 | iv. a notice that refers to the disclaimer of 248 | warranties; 249 | 250 | v. a URI or hyperlink to the Licensed Material to the 251 | extent reasonably practicable; 252 | 253 | b. indicate if You modified the Licensed Material and 254 | retain an indication of any previous modifications; and 255 | 256 | c. indicate the Licensed Material is licensed under this 257 | Public License, and include the text of, or the URI or 258 | hyperlink to, this Public License. 259 | 260 | 2. You may satisfy the conditions in Section 3(a)(1) in any 261 | reasonable manner based on the medium, means, and context in 262 | which You Share the Licensed Material. For example, it may be 263 | reasonable to satisfy the conditions by providing a URI or 264 | hyperlink to a resource that includes the required 265 | information. 266 | 267 | 3. If requested by the Licensor, You must remove any of the 268 | information required by Section 3(a)(1)(A) to the extent 269 | reasonably practicable. 270 | 271 | 4. If You Share Adapted Material You produce, the Adapter's 272 | License You apply must not prevent recipients of the Adapted 273 | Material from complying with this Public License. 274 | 275 | 276 | Section 4 -- Sui Generis Database Rights. 277 | 278 | Where the Licensed Rights include Sui Generis Database Rights that 279 | apply to Your use of the Licensed Material: 280 | 281 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 282 | to extract, reuse, reproduce, and Share all or a substantial 283 | portion of the contents of the database for NonCommercial purposes 284 | only; 285 | 286 | b. if You include all or a substantial portion of the database 287 | contents in a database in which You have Sui Generis Database 288 | Rights, then the database in which You have Sui Generis Database 289 | Rights (but not its individual contents) is Adapted Material; and 290 | 291 | c. You must comply with the conditions in Section 3(a) if You Share 292 | all or a substantial portion of the contents of the database. 293 | 294 | For the avoidance of doubt, this Section 4 supplements and does not 295 | replace Your obligations under this Public License where the Licensed 296 | Rights include other Copyright and Similar Rights. 297 | 298 | 299 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 300 | 301 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 302 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 303 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 304 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 305 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 306 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 307 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 308 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 309 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 310 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 311 | 312 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 313 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 314 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 315 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 316 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 317 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 318 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 319 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 320 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 321 | 322 | c. The disclaimer of warranties and limitation of liability provided 323 | above shall be interpreted in a manner that, to the extent 324 | possible, most closely approximates an absolute disclaimer and 325 | waiver of all liability. 326 | 327 | 328 | Section 6 -- Term and Termination. 329 | 330 | a. This Public License applies for the term of the Copyright and 331 | Similar Rights licensed here. However, if You fail to comply with 332 | this Public License, then Your rights under this Public License 333 | terminate automatically. 334 | 335 | b. Where Your right to use the Licensed Material has terminated under 336 | Section 6(a), it reinstates: 337 | 338 | 1. automatically as of the date the violation is cured, provided 339 | it is cured within 30 days of Your discovery of the 340 | violation; or 341 | 342 | 2. upon express reinstatement by the Licensor. 343 | 344 | For the avoidance of doubt, this Section 6(b) does not affect any 345 | right the Licensor may have to seek remedies for Your violations 346 | of this Public License. 347 | 348 | c. For the avoidance of doubt, the Licensor may also offer the 349 | Licensed Material under separate terms or conditions or stop 350 | distributing the Licensed Material at any time; however, doing so 351 | will not terminate this Public License. 352 | 353 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 354 | License. 355 | 356 | 357 | Section 7 -- Other Terms and Conditions. 358 | 359 | a. The Licensor shall not be bound by any additional or different 360 | terms or conditions communicated by You unless expressly agreed. 361 | 362 | b. Any arrangements, understandings, or agreements regarding the 363 | Licensed Material not stated herein are separate from and 364 | independent of the terms and conditions of this Public License. 365 | 366 | 367 | Section 8 -- Interpretation. 368 | 369 | a. For the avoidance of doubt, this Public License does not, and 370 | shall not be interpreted to, reduce, limit, restrict, or impose 371 | conditions on any use of the Licensed Material that could lawfully 372 | be made without permission under this Public License. 373 | 374 | b. To the extent possible, if any provision of this Public License is 375 | deemed unenforceable, it shall be automatically reformed to the 376 | minimum extent necessary to make it enforceable. If the provision 377 | cannot be reformed, it shall be severed from this Public License 378 | without affecting the enforceability of the remaining terms and 379 | conditions. 380 | 381 | c. No term or condition of this Public License will be waived and no 382 | failure to comply consented to unless expressly agreed to by the 383 | Licensor. 384 | 385 | d. Nothing in this Public License constitutes or may be interpreted 386 | as a limitation upon, or waiver of, any privileges and immunities 387 | that apply to the Licensor or You, including from the legal 388 | processes of any jurisdiction or authority. 389 | 390 | ======================================================================= 391 | 392 | Creative Commons is not a party to its public 393 | licenses. Notwithstanding, Creative Commons may elect to apply one of 394 | its public licenses to material it publishes and in those instances 395 | will be considered the “Licensor.” The text of the Creative Commons 396 | public licenses is dedicated to the public domain under the CC0 Public 397 | Domain Dedication. Except for the limited purpose of indicating that 398 | material is shared under a Creative Commons public license or as 399 | otherwise permitted by the Creative Commons policies published at 400 | creativecommons.org/policies, Creative Commons does not authorize the 401 | use of the trademark "Creative Commons" or any other trademark or logo 402 | of Creative Commons without its prior written consent including, 403 | without limitation, in connection with any unauthorized modifications 404 | to any of its public licenses or any other arrangements, 405 | understandings, or agreements concerning use of licensed material. For 406 | the avoidance of doubt, this paragraph does not form part of the 407 | public licenses. 408 | 409 | Creative Commons may be contacted at creativecommons.org. 410 | --------------------------------------------------------------------------------