Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
szepeviktor committed Oct 29, 2023
1 parent 70ce3d4 commit ca5dff7
Show file tree
Hide file tree
Showing 22 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion AWL_Backup/build/conf/logging.properties
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ handlers= java.util.logging.ConsoleHandler
# Default global logging level.
# This specifies which kinds of events are logged across
# all loggers. For any given facility this global level
# can be overriden by a facility specific level
# can be overridden by a facility specific level
# Note that the ConsoleHandler also has a separate level
# setting to limit messages printed to the console.
.level= INFO
Expand Down
2 changes: 1 addition & 1 deletion AWL_Backup/build/conf/security/java.policy
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ grant {
// allows anyone to listen on dynamic ports
permission java.net.SocketPermission "localhost:0", "listen";

// "standard" properies that can be read by anyone
// "standard" properties that can be read by anyone
permission java.util.PropertyPermission "java.version", "read";
permission java.util.PropertyPermission "java.vendor", "read";
permission java.util.PropertyPermission "java.vendor.url", "read";
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Take your Awtrix experience to the next level with the mobile app, tailored for

#### **Features:**
- **Liveview:** See your Awtrix in real-time.
- **Settings Customization:** Tweak text colors, set transistion and many more with just your fingertip.
- **Settings Customization:** Tweak text colors, set transition and many more with just your fingertip.
- **Icon Management:** View, or delete icons effortlessly.
- **Exclusive Icon Database:** Get unique icons only available for app users.
- **Icon Creation & Sharing:** Design and share your icons with our community.
Expand Down
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ You can adjust each property in the JSON object according to your preferences. I
**Color Values**: Can either be an RGB array (e.g., `[255,0,0]`) or a valid 6-digit hexadecimal color value (e.g., "#FF0000" for red).


**Transision effects:**
**Transition effects:**
```bash
0 - Random
1 - Slide
Expand Down
2 changes: 1 addition & 1 deletion docs/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There are numerous benefits to this approach:
- **Efficient resource management:** Save valuable flash memory space on the ESP module.
- **Adaptability:** No need to rewrite the firmware if an API undergoes changes.

You can use any system you like wich is able to build json strings and send them to a mqtt topic.
You can use any system you like which is able to build json strings and send them to a mqtt topic.

## AWTRIX FLOWS
This is your go-to hub for sharing and discovering AWTRIX Light automations, also known as custom Apps for several services.
Expand Down
8 changes: 4 additions & 4 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ The JSON object has the following properties:
| `mirror_screen` | boolean | Mirrors the screen | `false` |
| `temp_dec_places` | integer | Number of decimal places for temperature measurements | `0` |
| `sensor_reading` | boolean | Enables or disables the reading of the Temp&Hum sensor | `true` |
| `temp_offset` | float | Sets the offset for the internal temperature messurement | `-9` |
| `hum_offset` | float | Sets the offset for the internal humidity messurement | `0` |
| `temp_offset` | float | Sets the offset for the internal temperature measurement | `-9` |
| `hum_offset` | float | Sets the offset for the internal humidity measurement | `0` |
| `min_brightness` | integer | Sets minimum brightness level for the Autobrightness control | `2` |
| `max_brightness` | integer | Sets maximum brightness level for the Autobrightness control. On high levels, this could result in overheating! | `180` |
| `min_battery` | integer | Calibrates the minimum battery messurement by the given raw value. You will get that from the stats api | `475` |
| `max_battery` | integer | Calibrates the maximum battery messurement by the given raw value. You will get that from the stats api | `665` |
| `min_battery` | integer | Calibrates the minimum battery measurement by the given raw value. You will get that from the stats api | `475` |
| `max_battery` | integer | Calibrates the maximum battery measurement by the given raw value. You will get that from the stats api | `665` |
| `ha_prefix` | string | Sets the prefix for Homassistant discovery | `homeassistant` |
| `background_effect` | string | Sets an [effect](https://blueforcer.github.io/awtrix-light/#/effects) as global background layer | - |
| `stats_interval` | integer | Sets the interval in milliseconds when awtrix should send its stats to HA and MQTT | 10000 |
Expand Down
6 changes: 3 additions & 3 deletions docs/effects.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Effects

AWTRIX light can show effects wherever you want
- Notification and CustomApps. This will show the effect as the first layer, so you can stil draw text over it.
- Notification and CustomApps. This will show the effect as the first layer, so you can still draw text over it.
- Backgroundlayer. This will show the effect behind everything and in each app. You can add it via Hidden features.

Just call the name for your favorite effect.
AWTRIX sends all effect names once after start via MQTT to stats/effects. So you can create external selectors.
Its also accessable via HTTTP /api/effects
Its also accessible via HTTTP /api/effects

<table>
<tr>
Expand Down Expand Up @@ -159,7 +159,7 @@ Remember, the colors you define in your palette serve as key points in the color
# Artnet (DMX)

Awtrix light supports Artnet out of the box.
For [Jinx!](http://www.live-leds.de/) you can <a href="awtrix_light.jnx" download>download this template</a>. Just change the IP of both universes to your awtrix IP and youre ready to go.
For [Jinx!](http://www.live-leds.de/) you can <a href="awtrix_light.jnx" download>download this template</a>. Just change the IP of both universes to your awtrix IP and you're ready to go.

**For any Other Artnet controller:**
Create 2 universes with 384 channels each. Also add a new matrix layout with 8 strings á 32 Strands and top left starting position. When you start to send data, AWTRIX will stop its normal operation and shows your data. 1s after you stop sending data, AWTRIX will return to normal operation.
Expand Down
2 changes: 1 addition & 1 deletion docs/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ You can also create your own icon and place it in the "ICONS" folder via the web
The icon needs to be a GIF (.gif) or JPG (.jpg) with a resolution of 8x8.

!> The Awtrix GIF renderer only supports 8bit gifs at the moment without transparency.
If you have some graphic glitches on the matrix, try to replace the transparency pixels with solid blak color.
If you have some graphic glitches on the matrix, try to replace the transparency pixels with solid black color.
For example with this [online tool](https://onlinegiftools.com/add-gif-background)
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
1. :computer: Connect your device to your PC or Mac and [use the online flasher](flasher.md)
2. :signal_strength: After flashing, Awtrix will open an access point with the name "awtrix_XXXXX". Connect with PW "12345678".
3. :mag: Open a browser and navigate to 192.168.4.1. Enter your WiFi information and connect to your WiFi.
4. :clock1: Your clock is accessible via the IP adress you see at connect.
4. :clock1: Your clock is accessible via the IP address you see at connect.
5. :gear: Set up your MQTT and other options in the web interface.
6. :heavy_check_mark: You're ready to go.
2 changes: 1 addition & 1 deletion src/Apps.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ void ShowCustomApp(String name, FastLED_NeoMatrix *matrix, MatrixDisplayUiState
DisplayManager.getInstance().resetTextColor();
}

// Unattractive to have a function for every customapp wich does the same, but currently still no other option found TODO
// Unattractive to have a function for every customapp which does the same, but currently still no other option found TODO

void CApp1(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, GifPlayer *gifPlayer)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Apps.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ void BatApp(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, i

void ShowCustomApp(String name, FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, GifPlayer *gifPlayer);

// Unattractive to have a function for every customapp wich does the same, but currently still no other option found TODO
// Unattractive to have a function for every customapp which does the same, but currently still no other option found TODO
void CApp1(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, GifPlayer *gifPlayer);
void CApp2(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, GifPlayer *gifPlayer);
void CApp3(FastLED_NeoMatrix *matrix, MatrixDisplayUiState *state, int16_t x, int16_t y, GifPlayer *gifPlayer);
Expand Down
2 changes: 1 addition & 1 deletion src/ArtnetWifi.h
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ class ArtnetWifi
}

[[deprecated]]
inline void setPhisical(uint8_t port)
inline void setPhysical(uint8_t port)
{
setPhysical(port);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Dictionary.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ const char HAramName[] PROGMEM = {"Free ram"};
const char HAramClass[] PROGMEM = {"data_size"};
const char HAramUnit[] PROGMEM = {"B"};

// JSON properites
// JSON properties
#ifndef awtrix2_upgrade
const char BatKey[] PROGMEM = {"bat"};
const char BatRawKey[] PROGMEM = {"bat_raw"};
Expand Down
2 changes: 1 addition & 1 deletion src/Dictionary.h
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ extern const char HAramName[];
extern const char HAramClass[];
extern const char HAramUnit[];

// JSON properites
// JSON properties
#ifndef awtrix2_upgrade
extern const char BatKey[];
extern const char BatRawKey[];
Expand Down
2 changes: 1 addition & 1 deletion src/DisplayManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2389,7 +2389,7 @@ String DisplayManager_::getEffectNames()
return result;
}

String DisplayManager_::getTransistionNames()
String DisplayManager_::getTransitionNames()
{
char effectOptions[100];
strcpy_P(effectOptions, HAeffectOptions);
Expand Down
2 changes: 1 addition & 1 deletion src/DisplayManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ class DisplayManager_
CRGB *getLeds();
void forceNextApp();
String getEffectNames();
String getTransistionNames();
String getTransitionNames();
void drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint32_t color);
void drawFilledRect(int16_t x, int16_t y, int16_t w, int16_t h, uint32_t color);
void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint32_t color);
Expand Down
2 changes: 1 addition & 1 deletion src/Globals.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ void startLittleFS()
else
{
if (DEBUG_MODE)
DEBUG_PRINTLN(F("Filesystem currupt. Formating..."));
DEBUG_PRINTLN(F("Filesystem corrupt. Formatting..."));
LittleFS.format();
ESP.restart();
}
Expand Down
2 changes: 1 addition & 1 deletion src/MQTTManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ void onMqttConnected()
version->setValue(VERSION);
}
MQTTManager.publish("stats/effects", DisplayManager.getEffectNames().c_str());
MQTTManager.publish("stats/transitions", DisplayManager.getTransistionNames().c_str());
MQTTManager.publish("stats/transitions", DisplayManager.getTransitionNames().c_str());
connected = true;
}

Expand Down
26 changes: 13 additions & 13 deletions src/MatrixDisplayUi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Copyright (c) 2016 by Daniel Eichhorn
* Copyright (c) 2016 by Fabrice Weinberg
* Copyright (c) 2023 by Stephan Muehl (Blueforcer)
* Note: This old lib for SSD1306 displays has been extremly
* Note: This old lib for SSD1306 displays has been extremely
* modified for AWTRIX Light and has nothing to do with the original purposes.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down Expand Up @@ -64,7 +64,7 @@ void MatrixDisplayUi::setBackgroundEffect(int effect)
this->BackgroundEffect = effect;
}

// -/------ Automatic controll ------\-
// -/------ Automatic control ------\-

void MatrixDisplayUi::enablesetAutoTransition()
{
Expand Down Expand Up @@ -125,12 +125,12 @@ void MatrixDisplayUi::setBackground(BackgroundCallback backgroundFunction)
this->backgroundFunction = backgroundFunction;
}

// -/----- Manuel control -----\-
// -/----- Manual control -----\-
void MatrixDisplayUi::nextApp()
{
if (this->state.appState != IN_TRANSITION)
{
this->state.manuelControll = true;
this->state.manualControl = true;
this->state.appState = IN_TRANSITION;
this->state.ticksSinceLastStateSwitch = 0;
this->lastTransitionDirection = this->state.appTransitionDirection;
Expand All @@ -141,7 +141,7 @@ void MatrixDisplayUi::previousApp()
{
if (this->state.appState != IN_TRANSITION)
{
this->state.manuelControll = true;
this->state.manualControl = true;
this->state.appState = IN_TRANSITION;
this->state.ticksSinceLastStateSwitch = 0;
this->lastTransitionDirection = this->state.appTransitionDirection;
Expand Down Expand Up @@ -170,7 +170,7 @@ void MatrixDisplayUi::transitionToApp(uint8_t app)
return;
this->nextAppNumber = app;
this->lastTransitionDirection = this->state.appTransitionDirection;
this->state.manuelControll = true;
this->state.manualControl = true;
this->state.appState = IN_TRANSITION;
this->state.appTransitionDirection = app < this->state.currentApp ? -1 : 1;
}
Expand All @@ -187,7 +187,7 @@ int8_t MatrixDisplayUi::update()
int8_t timeBudget = this->updateInterval - (appStart - this->state.lastUpdate);
if (timeBudget <= 0)
{
// Implement frame skipping to ensure time budget is keept
// Implement frame skipping to ensure time budget is kept
if (this->setAutoTransition && this->state.lastUpdate != 0)
this->state.ticksSinceLastStateSwitch += ceil(-timeBudget / this->updateInterval);

Expand Down Expand Up @@ -216,11 +216,11 @@ void MatrixDisplayUi::tick()
}
break;
case FIXED:
// Revert manuelControll
if (this->state.manuelControll)
// Revert manualControl
if (this->state.manualControl)
{
this->state.appTransitionDirection = 1;
this->state.manuelControll = false;
this->state.manualControl = false;
}
if (this->state.ticksSinceLastStateSwitch >= this->ticksPerApp)
{
Expand Down Expand Up @@ -351,15 +351,15 @@ TransitionType getRandomTransition()
return static_cast<TransitionType>((rand() % (CROSSFADE)) + 1);
}

bool swaped = false;
bool swapped = false;

void MatrixDisplayUi::drawApp()
{
switch (this->state.appState)
{
case IN_TRANSITION:
{
swaped = false;
swapped = false;
gotNewTransition = false;
if (currentTransition == SLIDE)
{
Expand Down Expand Up @@ -418,7 +418,7 @@ void MatrixDisplayUi::drawApp()
}

(this->AppFunctions[this->state.currentApp])(this->matrix, &this->state, 0, 0, &gif1);
swaped = true;
swapped = true;
break;
}
}
Expand Down
6 changes: 3 additions & 3 deletions src/MatrixDisplayUi.h
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ struct MatrixDisplayUiState
// Normal = 1, Inverse = -1;
int8_t appTransitionDirection = 1;
bool lastFrameShown = false;
bool manuelControll = false;
bool manualControl = false;

// Custom data that can be used by the user
void *userData = NULL;
Expand Down Expand Up @@ -113,7 +113,7 @@ class MatrixDisplayUi
// UI State
MatrixDisplayUiState state;

// Bookeeping for update
// Bookkeeping for update
long updateInterval = 33;

void drawApp();
Expand Down Expand Up @@ -149,7 +149,7 @@ class MatrixDisplayUi
void setTargetFPS(uint8_t fps);

void setBackgroundEffect(int effect);
// Automatic Controll
// Automatic Control
/**
* Enable automatic transition to next app after the some time can be configured with `setTimePerApp` and `setTimePerTransition`.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/ServerManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ void addHandler()
mws.addHandler("/api/effects", HTTP_GET, []()
{ mws.webserver->send_P(200, "application/json", DisplayManager.getEffectNames().c_str()); });
mws.addHandler("/api/transitions", HTTP_GET, []()
{ mws.webserver->send_P(200, "application/json", DisplayManager.getTransistionNames().c_str()); });
{ mws.webserver->send_P(200, "application/json", DisplayManager.getTransitionNames().c_str()); });
mws.addHandler("/api/reboot", HTTP_ANY, []()
{ mws.webserver->send(200,F("text/plain"),F("OK")); delay(200); ESP.restart(); });
mws.addHandler("/api/rtttl", HTTP_POST, []()
Expand Down
2 changes: 1 addition & 1 deletion src/UpdateManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ void UpdateManager_::updateFirmware()
switch (ret)
{
case HTTP_UPDATE_FAILED:
if (DEBUG_MODE) DEBUG_PRINTF("HTTP_UPDATE_FAILD Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str());
if (DEBUG_MODE) DEBUG_PRINTF("HTTP_UPDATE_FAILED Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str());
break;

case HTTP_UPDATE_NO_UPDATES:
Expand Down

0 comments on commit ca5dff7

Please sign in to comment.