Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 2.81 KB

README.md

File metadata and controls

74 lines (57 loc) · 2.81 KB
Raw

Arduino SPIFFS FilePrint Library

https://github.com/PRosenb/SPIFFS_FilePrint

SPIFFS FilePrint is a lightweight, simple library for rolling file print to log to SPIFFS.

Features

  • Easy to use
  • Supports rolling files
  • Lightweight

Installation

  • Download the latest version
  • Uncompress the downloaded file
  • This will result in a folder containing all the files for the library. The folder name includes the version: SPIFFS_FilePrint-x.y.z
  • Rename the folder to SPIFFS_FilePrint
  • Copy the renamed folder to your libraries folder
  • From time to time, check on https://github.com/PRosenb/SPIFFS_FilePrint if updates become available

Getting Started

Simple Logger:

#include <SpiffsFilePrint.h>

void setup() {
    Serial.begin(115200);

    if (!SPIFFS.begin()) {
        Serial.println("SPIFFS Mount Failed, we format it");
        SPIFFS.format();
    }
    // SPIFFS.format();

    SpiffsFilePrint filePrint("/logfile", 2, 500, &Serial);
    // skip open() or call close() if you want to deactivate writing to files
    filePrint.open();

    filePrint.print("Millis since start: ");
    filePrint.println(millis());

    filePrint.close();
}

void loop() {
}

Examples

The following example sketches are included in the PIFFS FilePrint library.
You can also see them in the Arduino Software (IDE) in menu File->Examples->SPIFFS FilePrint.

  • Simple Logging: Simple example how to use this library.
  • Print to file and console: Print to the console and to a file at the same time and show the content of the logfile.
  • Log with ArduinoLog: Use ArduinoLog and configure it to log to a log file. Show the content of the logfile afterwards.

Contributions

Enhancements and improvements are welcome.

License

Arduino PIFFS FilePrint Library
Copyright (c) 2022 Peter Rosenberg (https://github.com/PRosenb).

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.