Skip to content

Commit

Permalink
fix: clean up broken links (#157)
Browse files Browse the repository at this point in the history
* fix: clean up broken links

* fix: update parameter in contribution guide

* fix: add company name to website title

* fix: update links or point to parent folders

* fix: further clean up lycheeignore
  • Loading branch information
f-hollow authored Oct 24, 2024
1 parent 96ec8ee commit 51babc4
Show file tree
Hide file tree
Showing 24 changed files with 75 additions and 83 deletions.
14 changes: 3 additions & 11 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
http://ser-book.com/espnostd
http://ser-book.com/espstd
https://www.theembeddedrustacean.com/subscribe
# content/pages/chip-support-status/esp32c61/index.md
https://docs.espressif.com/projects/esp-modbus/en/latest/esp32c61/
# content/blog/nuttx-adding-porting-an-app/index.md
https://github.com/ARMmbed/mbedtls/archive

# Domains which rejects validation requests from GitHub Action
# Domains known to reject validation requests from GitHub Actions
https://www.kickstarter.com
https://platform.openai.com
https://openai.com/
Expand All @@ -22,18 +20,12 @@ https://www.instagram.com
https://espressif.us15.list-manage.com
https://code.visualstudio.com

# Domains returning time-to-time 500
# Domains periodically returning 500
https://www.analog.com
https://educ8s.tv

# Domains with frequent time out
# Domains with frequent timeouts
https://www.waveshare.com

# Bug in Lychee
https://products.espressif.com/

# Links from examples
socket://localhost

# Bug on Lychee (see later)
https://products.espressif.com/
2 changes: 1 addition & 1 deletion config/_default/languages.en.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
languageCode = "en"
languageName = "English"
weight = 1
title = "Developer Portal"
title = "Espressif Developer Portal"

[params]
displayName = "EN"
Expand Down
2 changes: 1 addition & 1 deletion content/blog/april-2018/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Hi everyone, The month of April is an exciting one for Espressif, since it is ou

Our brand new audio development boards, [ESP32-LyraTD-MSC](https://www.espressif.com/sites/default/files/documentation/esp32-lyratd-msc_user_guide_en.pdf) and [ESP32-LyraT](https://docs.espressif.com/projects/esp-adf/en/latest/design-guide/dev-boards/), have been officially released and our customers can order them or make enquiries about them through our [CRM system](https://www.espressif.com/en/company/contact/pre-sale-questions-crm). Also, [ESP32-WROOM-32D](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf) is now available to the Japanese market through [www.switch-science.com](https://www.switch-science.com/catalog/3753/). ESP32-WROOM-32D is a powerful Wi-Fi+BT/BLE module that targets a wide variety of applications, ranging from low-power sensor networks to the most demanding tasks, such as voice encoding, music streaming and MP3 decoding.

Additionally, our presence in Europe is becoming stronger by the day. Our branch in the Czech Republic is developing quickly, while also our distribution partners in France, Astone Technology, brought Espressif to the spotlight in the latest exhibition in Paris about [embedded systems and machine-to-machine (M2M) communications](http://www.zyyne.com/zh5/224667#p=2) at the Expo Porte de Versailles on 21 and 22 March 2018.
Additionally, our presence in Europe is becoming stronger by the day. Our branch in the Czech Republic is developing quickly, while also our distribution partners in France, Astone Technology, brought Espressif to the spotlight in the latest exhibition in Paris about [embedded systems and machine-to-machine (M2M) communications](https://www.zyyne.com/) at the Expo Porte de Versailles on 21 and 22 March 2018.

Most importantly, however, the latest report by [Techno Systems Research](http://www.t-s-r.co.jp/) regarding the 2017 market shares in the semiconductorindustry was released last month, showing that Espressif Systems ranked first in the MCU Embedded Wi-Fi market with a share of about 30%, which was well over that of our competitors. As our company continues to develop, it is important to us to be not only a mainstream IoT company, but an integral part of the innovation that drives the semiconductor industry forward. We will continue creating IoT solutions that deliver exactly this. Furthermore, we will remain loyal to our motto about the democratization of technology, maintaining our competitive prices which allow everyone’s access to the alluring world of IoT.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can track all work in progress by following our GitHub repository. If you fi

[espressif/arduino-esp32If you want to test ESP32-S2 and/or ESP32-C3 through the board manager, please use the development release link…github.com](https://github.com/espressif/arduino-esp32?source=post_page-----f36d79967eb8--------------------------------)

See “[how to contribute](https://github.com/espressif/arduino-esp32/blob/master/CONTRIBUTING.rst)” for more details on how to help us to improve.
See “[how to contribute](https://github.com/espressif/arduino-esp32/)” for more details on how to help us to improve.

## New Supported SoC

Expand Down Expand Up @@ -70,11 +70,11 @@ If you want to try this new version, you just need to update your ESP32-Arduino

First, go to our GitHub repository: [arduino-esp32](https://github.com/espressif/arduino-esp32)

__For Arduino IDE < 2.0__
__For Arduino IDE < 2.0__

If you are using the Arduino IDE < 2.0, you can install or update using these steps:

__File → Preferences__
__File → Preferences__

{{< figure
default=true
Expand All @@ -94,11 +94,11 @@ Be sure to select the version 2.0.0-alpha1.

If the version 2.0.0 isn’t in the list, update the JSON link in the “Additional Boards Manager URLs” and restart the Arduino IDE.

__For the Arduino IDE 2.0:__
__For the Arduino IDE 2.0:__

The process for the Arduino IDE 2.0 is very similar to the early version.

__File → Preferences__
__File → Preferences__

{{< figure
default=true
Expand All @@ -116,7 +116,7 @@ To install it, go to __Tools → Boards → Boards Manager__ and you will find

You can finally start using the ESP32-S2 and ESP32-C3 SoC with Arduino!

__Conclusion__
__Conclusion__

We are all excited with this preview version release to give you the chance to try our new chips using Arduino.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ tags:
---
A few weeks ago in [this article](/blog/making-the-fancy-user-interface-on-esp-has-never-been-easier) we have introduced SquareLine Studio and how it can be used to develop user interfaces. This feature was available only for Espressif’s boards. But what if we wanted to use this tool for our custom designed board based on an ESP chip with a custom LCD? Here is the solution!

What is the best way to add a custom board into SquareLine Studio? Start with the [*custom_waveshare_7inch* example on from esp-bsp repository on GitHub](https://github.com/espressif/esp-bsp/tree/master/SquareLine/boards/custom_waveshare_7inch). This example is based on the same code as other Espressif’s examples for SquareLine Studio. However there is one big difference. There must be a custom component similar to Espressif’s BSP with main functions for handling the LCD screen and initialization of the LVGL graphic library.
What is the best way to add a custom board into SquareLine Studio? Start with the [*custom_waveshare_7inch* example on from esp-bsp repository on GitHub](https://github.com/espressif/esp-bsp/tree/master/SquareLine/boards/v8/custom_waveshare_7inch). This example is based on the same code as other Espressif’s examples for SquareLine Studio. However there is one big difference. There must be a custom component similar to Espressif’s BSP with main functions for handling the LCD screen and initialization of the LVGL graphic library.

For this example we have selected the following LCD display: [WaveShare 7inch 800x480 with RA8875 graphical controller and GT911 touch screen controller](https://www.waveshare.com/7inch-capacitive-touch-lcd-c.htm).

## 1. Making the custom BSP for your board

First step in preparing the package for the SquareLine Studio is to make a component similar to BSP. You can see implementation for the [7inch WaveShare LCD](https://www.waveshare.com/7inch-capacitive-touch-lcd-c.htm) in our example on [GitHub](https://github.com/espressif/esp-bsp/tree/master/SquareLine/boards/custom_waveshare_7inch), where only important functions are implemented in [__ws_7inch.c__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/ws_7inch.c) file. For other screens, the following functions should be changed:
First step in preparing the package for the SquareLine Studio is to make a component similar to BSP. You can see implementation for the [7inch WaveShare LCD](https://www.waveshare.com/7inch-capacitive-touch-lcd-c.htm) in our example on [GitHub](https://github.com/espressif/esp-bsp/tree/master/SquareLine/boards/v8/custom_waveshare_7inch), where only important functions are implemented in [__ws_7inch.c__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/components/ws_7inch/ws_7inch.c) file. For other screens, the following functions should be changed:

```
/* LCD display initialization */
Expand All @@ -43,13 +43,13 @@ esp_err_t bsp_i2c_init(void)
}
```

Second part of making a custom BSP is to edit the header file [__ws_7inch.h__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h). This is where are all pin configurations, communication speed configuration and screen size for the board are defined.
Second part of making a custom BSP is to edit the header file [__ws_7inch.h__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h). This is where are all pin configurations, communication speed configuration and screen size for the board are defined.

The last thing you should do is to modify [__CMakeLists.txt__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/CMakeLists.txt) and [__idf_component.yml__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/idf_component.yml), when any filename changes or when you need to use another component for the LCD screen or touch screen. You should modify [__idf_component.yml__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/main/idf_component.yml) in the main project too when the component name is changed.
The last thing you should do is to modify [__CMakeLists.txt__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/components/ws_7inch/CMakeLists.txt) and [__idf_component.yml__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/components/ws_7inch/idf_component.yml), when any filename changes or when you need to use another component for the LCD screen or touch screen. You should modify [__idf_component.yml__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/main/idf_component.yml) in the main project too when the component name is changed.

## 2. The board description file and board image

After the custom BSP is done, we can move to update the board description file____ [__manifest.json__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/manifest.json):
After the custom BSP is done, we can move to update the board description file____ [__manifest.json__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/manifest.json):

```
{
Expand All @@ -68,11 +68,11 @@ After the custom BSP is done, we can move to update the board description file__

Values __name__ , __version, mcu, short_description__ and __long_description__ are only for displaying your board right in the SquareLine Studio. There can be anything. More important are values __screen_width__ , __screen_height__ and __screen_color_swap__ , which define physical values for your LCD display. The __placeholders__ should be updated with the right values from your custom BSP. The header file path into ____ESP_BOARD_INCLUDE____ and touch screen initialization function into ____ESP_BOARD_I2C_INIT____ .

Second file for update is board image____ [__image.png__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/image.png). There must be a board image in size __380px__ x __300px__ .
Second file for update is board image____ [__image.png__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/image.png). There must be a board image in size __380px__ x __300px__ .

## 3. ESP-IDF and LVGL default configuration

If you have any specific changes in IDF configuration or LVGL configuration, you can put it into [__sdkconfig.defaults__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/sdkconfig.defaults) file. The configuration option __CONFIG_LV_COLOR_16_SWAP__ must be same like value in __screen_color_swap__ in [__manifest.json__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/custom_waveshare_7inch/manifest.json) file.
If you have any specific changes in IDF configuration or LVGL configuration, you can put it into [__sdkconfig.defaults__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/sdkconfig.defaults) file. The configuration option __CONFIG_LV_COLOR_16_SWAP__ must be same like value in __screen_color_swap__ in [__manifest.json__ ](https://github.com/espressif/esp-bsp/blob/master/SquareLine/boards/v8/custom_waveshare_7inch/manifest.json) file.

## 4. Generate and copy package for SquareLine Studio

Expand Down
4 changes: 2 additions & 2 deletions content/blog/embedding-voice-into-devices-with-esp32/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:
- IoT

---
ESP32 already supported being a fully functional [Alexa client](https://github.com/espressif/esp-va-sdk/blob/master/README-Alexa.md), a voice assistant.
ESP32 already supported being a fully functional [Alexa client](https://github.com/espressif/esp-va-sdk/tree/master/examples/amazon_alexa), a voice assistant.

ESP32 now also supports Dialogflow, a voice-enabled conversational interface from Google. It enables IoT users to include a natural language user interface in their devices.

Expand All @@ -24,7 +24,7 @@ The differences of Dialogflow w.r.t. voice assistants are

Unlike voice-assistants, Dialogflow let’s you configure every step of the conversation, and it won’t answer other trivia/questions like voice-assistants typically do. For example, a Dialogflow agent for a Laundry project will provide information only about the configurable parameters of the laundry (like state, temperature, wash cycle etc.)

This is now a part of Espressif’s Voice Assistant SDK and is available on github here: [https://github.com/espressif/esp-va-sdk](https://github.com/espressif/esp-va-sdk/blob/master/README-Dialogflow.md). To get started, see [this](https://github.com/espressif/esp-va-sdk/blob/master/README-Dialogflow.md).
This is now a part of Espressif’s Voice Assistant SDK and is available on github here: [https://github.com/espressif/esp-va-sdk](https://github.com/espressif/esp-va-sdk/tree/master/components/dialogflow-proto). To get started, see [this](https://github.com/espressif/esp-va-sdk/tree/master/components/dialogflow-proto).

The underlying technologies used by the Dialogflow implementation for VA SDK includes:

Expand Down
Loading

0 comments on commit 51babc4

Please sign in to comment.