Skip to content

Latest commit

 

History

History
122 lines (91 loc) · 5.31 KB

README.md

File metadata and controls

122 lines (91 loc) · 5.31 KB
Raw

hello.nrfcloud.com/map

GitHub Actions semantic-release Renovate @commitlint/config-conventional code style: prettier ESLint: TypeScript

Renovate

Map application written with Solid.js.

Project vision

Built a showcase that highlights Nordic Semiconductor's cellular IoT solutions by showing thousands of real connected devices, empowering customers to promote their solutions that make Nordic's ecosystem the best, and gathering valuable data to help future customer in their go-to-market efforts.

Overall, hello.nrfcloud.com/map shows a world where cellular IoT is seamlessly integrated into everyday life, powered by Nordic Semiconductor technology and fueled by a vibrant community of innovators.

Key Objectives

  • Promote Nordic Semiconductor cellular IoT solutions: Showcase real-world deployments of cellular IoT devices powered by Nordic Semiconductor hardware, demonstrating their diverse applications and capabilities to a global audience.
  • Empower customers: Provide a platform for customers to easily showcase their innovative products built with Nordic technology, increasing brand awareness and driving sales.
  • Collect up-to-date connectivity statistics: Gather real-time data on cellular network performance and device behavior from around the world, providing valuable insights for Nordic Semiconductor, network operators, and the broader IoT community.

Impact

  • Accelerate the adoption of cellular IoT: By showcasing successful deployments and customer solutions, hello.nrfcloud.com/map will inspire developers and businesses to embrace cellular IoT technology.

  • Strengthen the Nordic Semiconductor ecosystem: The platform will connect customers, developers, and partners, fostering collaboration and innovation within the cellular IoT space.

  • Drive industry insights: The collected data will provide valuable insights into cellular network performance, device behavior, and emerging trends, benefiting all stakeholders in the IoT ecosystem.

Solution

This is achieved through:

  • Seamless onboarding of Custom Devices: Leverages a well-defined API for device registration, eliminating manual configuration and streamlining the process. This allows the number of shown devices to grow organically.

  • LwM2M objects for Universal Data Representation: LwM2M objects describe data sent by devices, enabling automatic visualization without custom UI development. The platform supports various LwM2M objects for flexible data representation. This allows any customer to integrate their device's data into the platform through describing it via an LwM2M object (or reusing an existing one) without the need for custom development.

  • Customizable User Interface for Personalized Storytelling:

    • Provides a customizable UI, allowing users to curate and showcase specific devices or groups.
    • Enables filtering and sorting of devices based on various attributes like location, application, or sensor data.
    • Offers map-based visualization for geographically distributed deployments.
    • Integrates with external data sources for contextual enrichment (e.g., nRF Cloud Location API, Memfault Device Health Metrics, etc. ...).

Continuous integration

Deploy an instance of the AWS Map resources to the CI AWS account and store the map settings as variables:

# Make sure that the `ci` environment exists in this repo
gh variable set MAP_REGION --env ci --body "<mapRegion>"
gh variable set MAP_NAME --env ci --body "<mapName>"
gh variable set MAP_API_KEY --env ci --body "<apiKey>"

end-to-end tests

End-to-end tests are run completely without a backend using Vite's built-in dev server to serve the data.

Make sure to export MAP_REGION, MAP_NAME, and MAP_API_KEY before running it.

Note: It's currently not possible to run test for multiple browsers in parallel since the webServer > cannot be defined per project, and there is a state in the backend mock server that gets manipulated by the tests. So by default only the chrome project is run

npm run test:e2e

Run the Playwright code generator

Start the dev server:

npm run start:e2e

Run the interactive code generator:

npx playwright codegen