Skip to content

Commit

Permalink
change images and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tobyworks committed Oct 14, 2024
1 parent a905b54 commit 6ea8f34
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 19 deletions.
6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 15 additions & 19 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
# OpenAI Speech
OpenAI Speech

Allows you to use the OpenAI API to generate speech from text. The resulting file will be uploaded to your Homey's FTP.
Which then can be used in flows to play the audio file. For example to cast it to a Google Home device.

## App Configuration
- Install the HTTPFTP-Server app by Emile https://homey.app/nl-nl/app/net.weejewel.ftpserver/HTTPFTP-Server/
- Create a new FTP account in the FTP server app
- Get an OpenAI API key from https://platform.openai.com/api-keys
App Configuration
- Install the HTTPFTP-Server app by Emile https://homey.app/nl-nl/app/net.weejewel.ftpserver/HTTPFTP-Server/
- Create a new FTP account in the FTP server app
- Get an OpenAI API key from https://platform.openai.com/api-keys

## Device configuration
- Add a new device in the Homey app
- Select OpenAI Speech
- FIll in the settings
- OpenAI API key; the API key you got from the OpenAI platform
- Host; the IP address of your Homey
- FTP Port; the port of the FTP server (default is 2100)
- FTP Username; the username of the FTP account you created
- FTP Password; the password of the FTP account you created
- HTTP Port; the port of the HTTP server (default is 8000)

## Use in flows

![example_flow.png](docs/example_flow.png)
Device configuration
- Add a new device in the Homey app
- Select OpenAI Speech
- FIll in the settings
- OpenAI API key; the API key you got from the OpenAI platform
- Host; the IP address of your Homey
- FTP Port; the port of the FTP server (default is 2100)
- FTP Username; the username of the FTP account you created
- FTP Password; the password of the FTP account you created
- HTTP Port; the port of the HTTP server (default is 8000)
Binary file modified assets/images/large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/xlarge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified icons.sketch
Binary file not shown.

0 comments on commit 6ea8f34

Please sign in to comment.