Version 1.9.1

New features

• Architecture

  • Upgrade to SpringBoot 3.3.0

• LNS

  • Chirpstack upgrade to version 4.7.0
    This impacts the way sessions key are managed, they are moved from Redis to Postgres, a migration is required
  • Increase Chirpstack postgresql connection pool

• Back

  • fix some metrics mistakes
  • improve tenant creation in a parallel execution context
  • fix the JPA update hibernate / spring bug
  • fix the 7 days tenant stats display broken
  • fix charset problem related to invoice generation

• Front

  • invoice file have a user friendly name
  • admin can update the max_copy default in templates

Configuration file impact

• Makefile
• docker-compose.yml
  • Update Chirpstack versions
• configuration.properties
• nginx config files
  • Add a redirection for gateway creation to make sure user don't get lost with this.
• mosquitto.conf
• grafana
  • chirpstack dashboad updated
  • alert configuration file moved for auto commissionning
• prometheus
• chirpstack
  • max_open_connections change from 10 to 30 in file chirpstack.toml

upgrade procedure from 1.8.1

You need to upgrade version after version at least to make sure you applied all the configuration file change.

• git pull community
• git checkout main
• git pull community main
• git checkout V1.9.1
• build back make back
• update the /helium/docker-compose.yml file with the change in template (see configuration file impact above)
• update the /helium/configuration/chirpstack/chirpstack.toml with changes in template (see configuration file impact above)
• update the /helium/configuration/nginx/default.conf with the change in template
• when having forwarder
  • update git pull in forwarder repo
  • make update-balancer
  • make update-nodes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures from /helium directory
• make front make front
• restart containers with docker compose stop then docker compose up -d, this will stop the communications and some packets will be lost
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Post upgrade patch deployment

• Device Session Migration to chirpstak 4.7

docker exec helium-chirpstack-1 chirpstack -c /etc/chirpstack migrate-device-sessions-to-postgres

Known issues

• none yet

Version 1.8.1

New features

• Architecture
  • Upgrade to SpringBoot 3.2
  • Upgrade Java libraries
  • Upgrade JVM to 21
  • Upgrade NodeJs
• LNS
  • Chirpstack upgrade to version 4.6.0
    This have an impact on integration, Chirpstack payload doesn't have time field anymore but gwTime and nsTime
  • Give a preference on RX2 for downlink in EU868
• Back
  • Improve packet counting and billing
  • Better management of Nova API timeout
• Front
  • no visible change

Configuration file impact

• Makefile
• docker-compose.yml
  • Update Chirpstack versions
• configuration.properties
  • Entries name change: spring.redis.* becomes spring.data.redis.*
  • Entry spring.data.redis.ssl becomes spring.data.redis.ssl.enabled
  • New entries for EDU and Advanced, not used in community version, can be left unchanged
• nginx config files
• mosquitto.conf
• grafana
  • chirpstack dashboad upated
• prometheus
• chirpstack
  • region_eu868.toml change rx2_prefer_on_link_budget=true to prefer RX2 on RX1 (not mandatory change)

upgrade procedure from 1.7.1

You need to upgrade version after version at least to make sure you applied all the configuration file change.

• git pull community
• git checkout main
• git pull community main
• git checkout V1.8.1
• upgrade environment

$ apt install  -y openjdk-21-jdk npm
$ npm install -g n
$ n lts
$ hash -r

• build back make back
• update the /helium/docker-compose.yml file with the change in template (see configuration file impact above)
• update the /helium/configuration/helium/configuration.properties with the change in template (see configuration file impact above)
• update the /helium/configuration/chirpstack/region_eu868.toml with changes in template (see configuration file impact above)
• when having forwarder
  • update git pull in forwarder repo
  • make update-balancer
  • make update-nodes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures from /helium directory
• make front make front
• restart containers with docker compose stop then docker compose up -d, this will stop the communications and some packets will be lost
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Post upgrade patch deployment

Known issues

• none yet

Version 1.7.1

New features

• Architecture
  • improve mosquitto settings
• LNS
  • fix Chirpstack global bug on channels allocation for au915-2
  • extends the channels to 8 for as923-3
• Back
  • Admin messages supports more than 256 chars now
  • Improve route resync progression traces
  • Better management of the late packets
  • Unvalidate session token immediately for banned users.
  • Improve the email pattern verification to accept + symbol
  • Better route cleaning after tenant removal
  • Rearchictectured Event listener for better performance and scalability
• Front
  • Do not try to activate a device imported from a different OUI
  • Improved translations

Bugfix

• In certain condition it was possible to have multiple registration entries for a single user

Configuration file impact

• Makefile
• [] docker-compose.yml
• configuration.properties
  • New entry: chirpstack.dedup.delay.ms=350 LNS reception windows for deduplication
• nginx config files
• [x ] mosquitto.conf
  • mosquitto.conf file updated
• grafana
  • chirpstack dashboad upated
• [] prometheus
  • update prometheus.yml.withforwarder to scrap forwarders
• chirpstack
  • chirpstack.toml default parameter evolution for deduplication_delayto 350ms. It must match chirpstack.dedup.delay.ms=350
  • region_au915_2.toml change the channel selection, chirpstack bug in the configuration file, fixed locally
  • region_as923_3.toml add extra frequency to match Philippine radio plan

upgrade procedure from 1.6.1

• git pull community
• git pull community main
• git checkout V1.7.1
• build back & front make build
• update the /helium/configuration/helium/configuration.properties with the change in template
• update the /helium/configuration/chirpstack/chirpstack.toml with the changes in template
• update the /helium/configuration/chirpstack/region_au915_2.toml with changes in template
• update the /helium/configuration/chirpstack/region_as923_3.toml with changes in template
• update the /helium/configuration/mosquitto/mosquitto.conf with changes in template
• when having forwarder
  • update git pull in forwarder repo
  • make update-nodes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures
• restart containers with docker compose stop then docker compose up -d, this will stop the communications and some packets will be lost
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Post upgrade patch deployment

• git pull community
• git checkout V7.1.1
• make back
• restart containers with docker compose up -d

Known issues

• none yet

Version 1.6.1

New features

• Architecture
  • add forwarder metrics and update grafana
  • license changed for full GPLv3
  • github repo renamed for community edition
  • increase postgesql max_connection
• LNS
  • remove spaces in the regional toml files for better k8s support
• Back
  • improve mqtt reconnection on Listener
  • send email to paying users when DC balance is going low
  • send email to admin when the OUI balance is going low
  • verify HPR does not have unknown routes to LNS
  • make sure skfs resync is starting after euis resync
• Front
  • ability to ban a user in a click

Bugfix

• fix typo in Ms vs ms
• manually created user creation date fix

Configuration file impact

• Makefile
• docker-compose.yml
• configuration.properties
  • New entry: helium.oui.dc.alarm=4000000 for OUI DC level alert
  • New entry: helium.tenant.dc.warn=30000 and helium.tenant.dc.alarm=10000 for User DC level alert
• nginx config files
• mosquitto.conf
• grafana
  • chirpstack dashboad upated
• prometheus
  • update prometheus.yml.withforwarder to scrap forwarders
• chirpstack
  • regional .toml file updated, no need to update as it is just impacting k8s deployments

upgrade procedure from 1.5.1

• update your git configuration git remote add community https://github.com/disk91/helium-chirpstack-community.git
• git pull community main
• git checkout V1.6.1
• build back & front make build
• update the /helium/configuration/helium/configuration.properties with the change in template
• when having forwarder
  • update git pull in forwarder repo
  • make update-nodes
  • make update-balancer
• update /helium/configuration/prometheus/prometheus.yml file with template when forwarder is deployed
• update /helium/docker-compose.yml file with changes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures
• restart containers with docker compose stop then docker compose up -d, this will stop the communications and some packets will be lost
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Known issues

• none yet

Version 1.5.1

New features

• Architecture
  • Statistics are stored in a history table after a month and removed after a year.
  • Update JDK version to 21
• LNS
  • Clarify the way AU915 works with Helium (see configuration.properties)
• Back
  • Add email filtering rule for user registration
  • Rework the way the LoRaWan frames are counted, track the received packets (even when rejected)
  • Add API to finds new recent users and search users & associated tenants
  • Rework the way join billing is processed after helium made it free of charge
  • Improve and documents prometheus packet statistics
  • Create a new MQTT listener to process the internal message and not anymore busy the packet processing flow
  • Update grafana dashboard unbilled packet tracking
• Front
  • Add User Admin panel for admin
  • Admin can edit the Tenant Setup configuration
  • Display metric on tenant packets stats for the last 15 days, top active devices and inactive devices
  • Display metric to admin on top consuming tenants
  • Add Admin page to manage coupon, create and display

Bugfix

• Inactivity was invoiced the first time from device creation instead of last activity period
• Fix makeiteasy script failing in some particular cases

Configuration file impact

• Makefile
• docker-compose.ymp
• configuration.properties
  • New billing entries helium.billing.dcPerJoinRequest, helium.billing.maxJoinRequestDup, helium.billing.dcPerJoinAccept, better to setup it, but default value exists.
• nginx config files
• mosquitto.conf
• grafana
  • chirpstack dashboad upated
• chirpstack

upgrade procedure from 1.4.1

• git pull
• git checkout V1.5.1
• build back & front make build
• update the /helium/configuration/helium/configuration.properties with the change in template
• when having forwarder
  • update git pull in forwarder repo
  • make update-nodes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures
• restart containers with docker compose up -d
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Known issues

• When you have more than 100 tenants, the last page under 100 tenants is not updated with the join costs (fixed in 1.5.2)

Version 1.4.1

New features

• Architecture
  • Add an installation script to simplify the simple deployment
  • Better support for GPRC stream
• LNS
  • ADR margin changed from 10 to 15
  • Now chirpstack supports JOIN_EUI (APP_EUI)
• Back
  • add support of Chirpstack JOIN_EUI
  • Add support of MQTT and forwarded setup
  • Improve calculation of packet travel time, first packet arrival, raw packet reception, duplicates
  • Detect ABP configuration change to update HPR automatically
• Front
  • Hide migration menu for admin as it only works for standard users
  • Allow to hide tenant stats information
  • Display the pending support ticket number on the Menu directly
  • Allow the admin messages to display html

Bugfix

• size of tickets content was limited to 256c
• bug in condition reapproval
• upper case login was making trouble
• the OUI DC balance external api has changed and was not working anymore
• admin manually created tenant were not sync with HPR anymore
• use of invalid migration api key could lock the official legacy console
• when multiple devices are having the same SKF (meaning multiple device use the same appkey), HPR was rejecting the skfs creation
• invoice pdf does not support all charset and was crashing, now write a message instead
• in certain situation 1 single DC purchase could conduct to 2 DC wallet increase
• GPRC stream used by Chirpstack device Event and LoRaWan Frame screen were stopping after 1 minute and did not restarted correctly, now pushed to 1h.

Configuration file impact

• Makefile
  • new parameters to deactivate some features in frontend DIS_STAT_TENANT
• docker-compose.ymp
  • Volume /helium/cli/keypair for forwarder containers
• configuration.properties
  • nothing additionnal but template changed for automation
• nginx config files
  • add two section for grpc
  • change the way http2 is declared (previous one was deprecated)
• mosquitto.conf
• grafana
  • chirpstack dashboad upated
• chirpstack
  • chirsptack region configuration files must be upgraded

upgrade procedure from 1.3.0

• backup your Makefile
• backup your /helium/docker-compose.yml file
• git pull ( eventually need to git reset --hard before )
• restore your settings in Makefile
• build back & front make build
• copy region files cp chirpstack/configuration/chirpstack/region* /helium/configuration/chirpstack/
• update the /helium/configuration/nginx/default.conf with the change in template (2 grpc block + http2 declaration)
• when having forwarder
  • update the configuration file in /helium/configuration/forwarder/ with chirpstack/configuration/forwarder templates (add the GPRC section and setup the pubkey)
  • update git pull in forwarder repo
  • update docker-compose.yml according to chirpstack/docker-compose.withforwarder.yml ( add keypair.bin lines 2x )
  • make update-balancer (recommended, even if not mandatory - may loose packets integration)
  • make update-nodes
• make sure containers are up-to-date docker compose pull --ignore-pull-failures
• restart containers with docker compose up -d (this will restart chiprstack, some packets can be lost during < 1m)
• check restart is working good docker logs -f helium-helium-1
• reload the chirpstack dashboard on grafana from github raw file - Create new Dashboard - Import - copy/paste json - change name & Id

Known issues

• app_eui (potentially join_eui) change after initial setup is not correctly & automatically handled

Version 1.3.0

Configuration file impact

• Makefile
• docker-compose.ymp
  • Param GF_SMTP_ENABLED, typo fixed
  • Version of chirpstack updated
• configuration.properties
  • helium.route.reject.empty.skf, default false, set it to true to make HPR filtering unregistered device session
  • spring.redis.ssl, default false, set it to true if in your setup, your redis is secured by tls (don't do this on standard deployment)
  • helium.billing.vat, default 2000 (20%), set you local VAT for invoicing.
  • helium.zone.detection.enable, default false, set it true for detecting device zone change and have auto reconfiguration when possible
• nginx config files
  • add a section to route /api/ as /rest-api/ to make swagger-ui operational
• mosquitto.conf
  • add max_queued_messages to prevent queue size limitation

New features

• support redisS
• support the new Helium feature that filter skfs by default
• updated chirpstack version to 4.4.3
• updated java libs & spring version
• add feature flags to deactivate some entries in menu
• add menu entry link to api documentation
• user condition validation better traceability and revalidation
• mqtt use for listener the same client id to reconnect from last message
• support custom VAT

Bugfix

• limit the number of migrated devices in one shot to prevent low browser performance issues
• mqtt auto reconnect
• mass device live migration with parallel load was loosing some skfs initialization due to chirpstack API delayed
• stripe double crediting in certain conditions

upgrade procedure

• build back & front
• update the modified configuration files according to your need
• update nginx, docker-compose.yml, mosquitto conf file
• restart containers with docker-compose

Version 1.2.0

• Fix different issues & bugs
• Add the ability to move devices on the right region automatically

Version 1.1.1

Fix some small bugs seen in the installation process

Version 1.1.0

• Many improvement related to Helium evolution
• Improve signup
• add Integration