feat: added Project Livewire (#2017)

Author: heiko-hotz

.github/actions/spelling/allow.txt

@@ -261,6 +261,7 @@ LTRB
 LUVBPTK
 Ladhak
 Leventer
+Livewire
 Llion
 Lng
 Loghub
@@ -479,6 +480,7 @@ Tribbiani
 Tricyle
 UDF
 UDFs
+UIs
 USERDATA
 USK
 UVX
@@ -766,6 +768,7 @@ fillmode
 fillna
 fiqa
 firestore
+firewalls
 fixmycar
 flac
 floormat
@@ -1332,6 +1335,7 @@ womens
 workarounds
 worklets
 wparam
+wscat
 wscore
 wscores
 wstring

gemini/multimodal-live-api/project-livewire/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

gemini/multimodal-live-api/project-livewire/README.md

@@ -0,0 +1,137 @@
+# Project Livewire 
+
+**Talk to AI like never before! Project Livewire is a real-time, multimodal chat application showcasing the power of Gemini 2.0 Flash (experimental) Live API.**
+
+Think "Star Trek computer" interaction – speak naturally, show your webcam, share your screen, and get instant, streamed audio responses. Livewire brings this futuristic experience to your devices today.
+
+This project builds upon the concepts from the [Gemini Multimodal Live API Developer Guide](https://github.com/heiko-hotz/gemini-multimodal-live-dev-guide) with a focus on a more production-ready setup and enhanced features.
+
+## ✨ Key Features
+
+*   **🎤 Real-time Voice:** Natural, low-latency voice conversations.
+*   **👁️ Multimodal Input:** Combines voice, text, webcam video, and screen sharing.
+*   **🔊 Streamed Audio Output:** Hear responses instantly as they are generated.
+*   **↩️ Interruptible:** Talk over the AI, just like a real conversation.
+*   **🛠️ Integrated Tools:** Ask about the weather or check your calendar (via Cloud Functions).
+*   **📱 Responsive UI:** Includes both a development interface and a mobile-optimized view.
+*   **☁️ Cloud Ready:** Designed for easy deployment to Google Cloud Run.
+
+<!-- Optional: Add a GIF/Video Demo Here -->
+<!-- ![Demo GIF](assets/livewire-demo.gif) -->
+
+## 🚀 Getting Started
+
+Choose your path: run locally for development or deploy straight to the cloud.
+
+**Prerequisites:**
+
+*   Python 3.8+
+*   API Keys:
+    *   Google Gemini API Key ([Get one here](https://makersuite.google.com/app/apikey))
+    *   OpenWeather API Key ([Get one here](https://openweathermap.org/api) - for weather tool)
+*   Google Cloud SDK (`gcloud` CLI) (Recommended for cloud deployment & secrets)
+*   Deployed Tool Functions (See [Cloud Functions Guide](./cloud-functions/README.md))
+
+---
+
+### 1. 💻 Run Locally
+
+These are the basic steps. For more detailed instructions, see the **[Local Setup Guide](./docs/local_setup.md)**.
+
+1.  **Clone the repo:**
+    ```bash
+    git clone https://github.com/heiko-hotz/project-livewire.git
+    cd project-livewire
+    ```
+
+2.  **Configure Backend:**
+    ```bash
+    cd server
+    cp .env.example .env
+    nano .env # Edit with your API keys & Function URLs
+    # --> See server/README.md for detailed .env options <--
+    ```
+    *   *Minimum required in `.env`:* `GOOGLE_API_KEY` (if not using Vertex/ADC), `WEATHER_FUNCTION_URL`, etc.
+
+3.  **Run Backend:**
+    ```bash
+    pip install -r requirements.txt
+    python server.py
+    # Backend runs on localhost:8081
+    ```
+
+4.  **Run Frontend (in a *new* terminal):**
+    ```bash
+    cd ../client
+    python -m http.server 8000
+    # Frontend served on localhost:8000
+    ```
+
+5.  **Access:**
+    *   Dev UI: `http://localhost:8000/index.html`
+    *   Mobile UI: `http://localhost:8000/mobile.html`
+
+---
+
+### 2. ☁️ Deploy to Google Cloud Run
+
+This uses Cloud Build to containerize and deploy the client & server. For more detailed step-by-step instructions, refer to the **[Cloud Deployment Guide](./docs/cloud_deployment.md)**.
+
+1.  **Setup Google Cloud:**
+    *   Set your project: `gcloud config set project YOUR_GOOGLE_CLOUD_PROJECT`
+    *   Enable APIs (Run, Cloud Build, Secret Manager, etc.).
+    *   Create Secrets (`GOOGLE_API_KEY`, `OPENWEATHER_API_KEY`) in Secret Manager.
+    *   Create a Service Account (`livewire-backend`) with Secret Accessor role.
+    *   Deploy Tool Functions (See [Cloud Functions Guide](./cloud-functions/README.md)).
+
+2.  **Deploy Backend:**
+    ```bash
+    # Make sure GOOGLE_CLOUD_PROJECT is set in your environment or cloudbuild.yaml
+    gcloud builds submit --config server/cloudbuild.yaml
+    ```
+
+3.  **Get Backend URL:** Note the URL output by the previous command (or use `gcloud run services describe livewire-backend...`). Let's call it `YOUR_BACKEND_URL`.
+
+4.  **Deploy Frontend:**
+    ```bash
+    # Pass the backend URL to the frontend build
+    gcloud builds submit --config client/cloudbuild.yaml --substitutions=_BACKEND_URL=YOUR_BACKEND_URL
+    ```
+    *(Note: Ensure client code uses the provided `_BACKEND_URL` instead of localhost. See `docs/cloud_deployment.md` for details).*
+
+5.  **Access:** Get the frontend service URL (`gcloud run services describe livewire-ui...`) and open it in your browser.
+
+---
+
+## 🏗️ Architecture Overview
+
+Project Livewire consists of:
+
+1.  **Client (`client/`):** Vanilla JS frontend handling UI, media capture, and WebSocket connection. ([Details](./client/README.md))
+2.  **Server (`server/`):** Python WebSocket server proxying to Gemini, managing sessions, and calling tools. ([Details](./server/README.md))
+3.  **Tools (`cloud-functions/`):** Google Cloud Functions providing external capabilities (weather, calendar). ([Details](./cloud-functions/README.md))
+4.  **Gemini API:** Google's multimodal AI model accessed via the Live API.
+
+![Architecture Diagram](assets/architecture.png)
+*(User -> Client -> Server -> Gemini API / Tools -> Server -> Client -> User)*
+
+## 🔧 Tools & Configuration
+
+*   Tools like weather and calendar are implemented as separate Cloud Functions for modularity. See the [Cloud Functions README](./cloud-functions/README.md) for setup.
+*   Server configuration (API keys, Function URLs) is managed via environment variables and Google Cloud Secret Manager. See the [Server README](./server/README.md#configuration) for details.
+
+## ❓ Troubleshooting
+
+*   **Local:** Check terminal output for errors. Ensure API keys and Function URLs in `.env` are correct. Consult the [Local Setup Guide](./docs/local_setup.md).
+*   **Cloud Run:** Check Cloud Build and Cloud Run logs. Verify Service Account permissions and Secret Manager setup. Consult the [Cloud Deployment Guide](./docs/cloud_deployment.md).
+*   See component READMEs (`client/`, `server/`, `cloud-functions/`) for more specific tips.
+
+## 📜 License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file.
+
+## 🤝 Contributing & Disclaimer
+
+This is a personal project by [Heiko Hotz](https://github.com/heiko-hotz) to explore Gemini capabilities. Suggestions and feedback are welcome via Issues or Pull Requests.
+
+**This project is developed independently and does not reflect the views or efforts of Google.**

gemini/multimodal-live-api/project-livewire/assets/architecture.png

@@ -0,0 +1,24 @@
+FROM nginx:alpine
+
+# Create the directory structure
+RUN mkdir -p /usr/share/nginx/html
+
+# Copy mobile.html as index.html
+COPY mobile.html /usr/share/nginx/html/index.html
+
+# Copy other required files
+COPY styles /usr/share/nginx/html/styles
+COPY src /usr/share/nginx/html/src
+COPY assets /usr/share/nginx/html/assets
+
+# Copy nginx configuration
+COPY nginx.conf /etc/nginx/conf.d/default.conf
+
+# Create a simple health check file
+RUN echo "OK" > /usr/share/nginx/html/health
+
+# Expose port 8080 (Cloud Run requirement)
+EXPOSE 8080
+
+# Start nginx in foreground
+CMD ["nginx", "-g", "daemon off;"]