ExternalVendorCode/k3ng_rotator_controller
1
0
Fork 0
mirror of https://github.com/k3ng/k3ng_rotator_controller.git synced 2024-12-29 01:18:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
921280ca2b
k3ng_rotator_controller/libraries/digitalWriteFast/README.md
Anthony Good 56e6ed8233 2021.10.14.01 
FEATURE_STEPPER_MOTOR
          Removed OPTION_STEPPER_MOTOR_MAX_50_KHZ.  Too much overhead from interrupts.
          Implemented faster digital writes using digitalWriteFast library (library now included in Github)
          Added OPTION_STEPPER_DO_NOT_USE_DIGITALWRITEFAST_LIBRARY to disable digitalWriteFast library use
2021-10-13 20:58:48 -04:00

2.8 KiB
Executable File
Raw Blame History

digitalWriteFast

Arduino library for faster digitalWrite() using direct port manipulation and macro for ease in pin assignments. Which actually also does faster pinMode() and digitalRead().

Usage

Include the library: #include <digitalWriteFast.h>

Macro definitions:

  • digitalWriteFast(pinNum, state) (sets or clears pin/port faster)
  • pinModeFast(pinNum, mode) (sets pin/port as input or output faster)
  • digitalReadFast(pinNum)(reads the state of pin/port faster)

Parameters:

  • pinNum is the number written on the Arduino board.
  • state is weather pin is to be set HIGH or LOW
  • mode is weather pin is to be set INPUT or OUTPUT

In order to toggle fast, all the three parameters above must be constant or defined by the macro for ease in changes during compilation.

For example:

  • use '#define pinNum 10' instead of int pinNum = 10;
  • use 'const int pinNum 10' instead of int pinNum = 10;

Setting the parameter as a variable would cause the macro to return an error during compilation.

This makes sure digitalWriteFast that produces faster toggling, and notifies the programmer the specific area where toggling is slow. Otherwise, use normal digitalWrite

This is opposed to the forked library form Watterott, where if a variable is used as the parameter, the macro would revert to use sold digitalWrite, and remain undetected.

Speed

The regular digitalWrite() in Arduino Uno core (16MHz) takes about 6280nS while digitalWriteFast() port manipulation takes 125nS.

More info in: /NOTES/NOTES.md

This is a huge difference, especially or timing sensitive applications.

Direct port manipulation is troublesome where one has to refer to the pin assignment of the package and manipulate specific ports, instead of pin numbers on the Arduino board.

This library makes it easier by using digitalWriteFast() and the macro will replace it will the approritate port manipulation commands.

Compatibility

  • Arduino Due
  • Arduino Zero
  • Arduino Mega
  • Arduino with ATmega644 or Atmega644P chip
  • Arduino Leonardo
  • Arduino Uno (I have only tested with uno)

If not in the list, the macro will revert back to digitalWrite(), pinMode() or digitalRead()

Installation

  1. Download the repo as zip, extract and place into Arduino IDE libraries folder.
  2. Rename "digitalWriteFast-master" to "digitalWriteFast" Arduino IDE does not accept dash character.

Reference

Fork of Watterott's https://github.com/watterott/Arduino-Libs/tree/master/digitalWriteFast I just forked the whole repo, and delete unrelated files, I tried sparse checkout and gave up.

Watterott's digitalWriteFast could have used the below links as referrence.